pkgconnect

Documentation

Index

• Constants
• func NewAgentHandler(svc AgentHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type AgentClient
  • func NewAgentClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) AgentClient
• type AgentHandler
• type UnimplementedAgentHandler
  • func (UnimplementedAgentHandler) Config(context.Context, *connect.Request[pkg.ConfigRequest]) (*connect.Response[pkg.ConfigResponse], error)
  • func (UnimplementedAgentHandler) Heartbeat(context.Context, *connect.Request[pkg.HeartbeatRequest]) (*connect.Response[pkg.HeartbeatResponse], error)
  • func (UnimplementedAgentHandler) Register(context.Context, *connect.Request[pkg.RegisterRequest]) (*connect.Response[pkg.RegisterResponse], error)
  • func (UnimplementedAgentHandler) Submit(context.Context, *connect.Request[pkg.SubmitRequest]) (*connect.Response[pkg.SubmitResponse], error)
  • func (UnimplementedAgentHandler) Unregister(context.Context, *connect.Request[pkg.UnregisterRequest]) (*connect.Response[pkg.UnregisterResult], error)
  • func (UnimplementedAgentHandler) Users(context.Context, *connect.Request[pkg.UsersRequest]) (*connect.Response[pkg.UsersResponse], error)
  • func (UnimplementedAgentHandler) Verify(context.Context, *connect.Request[pkg.VerifyRequest]) (*connect.Response[pkg.VerifyResponse], error)

Constants

const (
	// AgentConfigProcedure is the fully-qualified name of the Agent's Config RPC.
	AgentConfigProcedure = "/pkg.Agent/Config"
	// AgentHeartbeatProcedure is the fully-qualified name of the Agent's Heartbeat RPC.
	AgentHeartbeatProcedure = "/pkg.Agent/Heartbeat"
	// AgentSubmitProcedure is the fully-qualified name of the Agent's Submit RPC.
	AgentSubmitProcedure = "/pkg.Agent/Submit"
	// AgentUsersProcedure is the fully-qualified name of the Agent's Users RPC.
	AgentUsersProcedure = "/pkg.Agent/Users"
	// AgentRegisterProcedure is the fully-qualified name of the Agent's Register RPC.
	AgentRegisterProcedure = "/pkg.Agent/Register"
	// AgentUnregisterProcedure is the fully-qualified name of the Agent's Unregister RPC.
	AgentUnregisterProcedure = "/pkg.Agent/Unregister"
	// AgentVerifyProcedure is the fully-qualified name of the Agent's Verify RPC.
	AgentVerifyProcedure = "/pkg.Agent/Verify"
)

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 (
	// AgentName is the fully-qualified name of the Agent service.
	AgentName = "pkg.Agent"
)

Functions

func NewAgentHandler

func NewAgentHandler(svc AgentHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewAgentHandler 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 AgentClient

type AgentClient interface {
	Config(context.Context, *connect.Request[pkg.ConfigRequest]) (*connect.Response[pkg.ConfigResponse], error)
	Heartbeat(context.Context, *connect.Request[pkg.HeartbeatRequest]) (*connect.Response[pkg.HeartbeatResponse], error)
	Submit(context.Context, *connect.Request[pkg.SubmitRequest]) (*connect.Response[pkg.SubmitResponse], error)
	Users(context.Context, *connect.Request[pkg.UsersRequest]) (*connect.Response[pkg.UsersResponse], error)
	Register(context.Context, *connect.Request[pkg.RegisterRequest]) (*connect.Response[pkg.RegisterResponse], error)
	Unregister(context.Context, *connect.Request[pkg.UnregisterRequest]) (*connect.Response[pkg.UnregisterResult], error)
	Verify(context.Context, *connect.Request[pkg.VerifyRequest]) (*connect.Response[pkg.VerifyResponse], error)
}

AgentClient is a client for the pkg.Agent service.

func NewAgentClient

func NewAgentClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) AgentClient

NewAgentClient constructs a client for the pkg.Agent 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 AgentHandler

type AgentHandler interface {
	Config(context.Context, *connect.Request[pkg.ConfigRequest]) (*connect.Response[pkg.ConfigResponse], error)
	Heartbeat(context.Context, *connect.Request[pkg.HeartbeatRequest]) (*connect.Response[pkg.HeartbeatResponse], error)
	Submit(context.Context, *connect.Request[pkg.SubmitRequest]) (*connect.Response[pkg.SubmitResponse], error)
	Users(context.Context, *connect.Request[pkg.UsersRequest]) (*connect.Response[pkg.UsersResponse], error)
	Register(context.Context, *connect.Request[pkg.RegisterRequest]) (*connect.Response[pkg.RegisterResponse], error)
	Unregister(context.Context, *connect.Request[pkg.UnregisterRequest]) (*connect.Response[pkg.UnregisterResult], error)
	Verify(context.Context, *connect.Request[pkg.VerifyRequest]) (*connect.Response[pkg.VerifyResponse], error)
}

AgentHandler is an implementation of the pkg.Agent service.

type UnimplementedAgentHandler

type UnimplementedAgentHandler struct{}

UnimplementedAgentHandler returns CodeUnimplemented from all methods.

func (UnimplementedAgentHandler) Config

func (UnimplementedAgentHandler) Config(context.Context, *connect.Request[pkg.ConfigRequest]) (*connect.Response[pkg.ConfigResponse], error)

func (UnimplementedAgentHandler) Heartbeat

func (UnimplementedAgentHandler) Heartbeat(context.Context, *connect.Request[pkg.HeartbeatRequest]) (*connect.Response[pkg.HeartbeatResponse], error)

func (UnimplementedAgentHandler) Register

func (UnimplementedAgentHandler) Register(context.Context, *connect.Request[pkg.RegisterRequest]) (*connect.Response[pkg.RegisterResponse], error)

func (UnimplementedAgentHandler) Submit

func (UnimplementedAgentHandler) Submit(context.Context, *connect.Request[pkg.SubmitRequest]) (*connect.Response[pkg.SubmitResponse], error)

func (UnimplementedAgentHandler) Unregister

func (UnimplementedAgentHandler) Unregister(context.Context, *connect.Request[pkg.UnregisterRequest]) (*connect.Response[pkg.UnregisterResult], error)

func (UnimplementedAgentHandler) Users

func (UnimplementedAgentHandler) Users(context.Context, *connect.Request[pkg.UsersRequest]) (*connect.Response[pkg.UsersResponse], error)

func (UnimplementedAgentHandler) Verify

func (UnimplementedAgentHandler) Verify(context.Context, *connect.Request[pkg.VerifyRequest]) (*connect.Response[pkg.VerifyResponse], error)