cfgconnect

Documentation

Index

• Constants
• func NewCfgHandler(svc CfgHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type CfgClient
  • func NewCfgClient(httpClient connect_go.HTTPClient, baseURL string, ...) CfgClient
• type CfgHandler
• type UnimplementedCfgHandler
  • func (UnimplementedCfgHandler) GetWebAgentConfig(context.Context, *connect_go.Request[cfg.GetWebAgentConfigReq]) (*connect_go.Response[cfg.WebAgent], error)

Constants

const (
	// CfgGetWebAgentConfigProcedure is the fully-qualified name of the Cfg's GetWebAgentConfig RPC.
	CfgGetWebAgentConfigProcedure = "/api.v1alpha1.cfg.Cfg/GetWebAgentConfig"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

const (
	// CfgName is the fully-qualified name of the Cfg service.
	CfgName = "api.v1alpha1.cfg.Cfg"
)

Functions

func NewCfgHandler

func NewCfgHandler(svc CfgHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewCfgHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type CfgClient

type CfgClient interface {
	// Get the configuration for a given web agent.
	GetWebAgentConfig(context.Context, *connect_go.Request[cfg.GetWebAgentConfigReq]) (*connect_go.Response[cfg.WebAgent], error)
}

CfgClient is a client for the api.v1alpha1.cfg.Cfg service.

func NewCfgClient

func NewCfgClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) CfgClient

NewCfgClient constructs a client for the api.v1alpha1.cfg.Cfg service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type CfgHandler

type CfgHandler interface {
	// Get the configuration for a given web agent.
	GetWebAgentConfig(context.Context, *connect_go.Request[cfg.GetWebAgentConfigReq]) (*connect_go.Response[cfg.WebAgent], error)
}

CfgHandler is an implementation of the api.v1alpha1.cfg.Cfg service.

type UnimplementedCfgHandler

type UnimplementedCfgHandler struct{}

UnimplementedCfgHandler returns CodeUnimplemented from all methods.

func (UnimplementedCfgHandler) GetWebAgentConfig

func (UnimplementedCfgHandler) GetWebAgentConfig(context.Context, *connect_go.Request[cfg.GetWebAgentConfigReq]) (*connect_go.Response[cfg.WebAgent], error)