clusterv1connect

Documentation

Index

• Constants
• func NewClusterServiceHandler(svc ClusterServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type ClusterServiceClient
  • func NewClusterServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ClusterServiceClient
• type ClusterServiceHandler
• type UnimplementedClusterServiceHandler
  • func (UnimplementedClusterServiceHandler) AnnounceStateChange(context.Context, *connect.Request[v1.AnnounceStateChangeRequest]) (*connect.Response[v1.AnnounceStateChangeResponse], error)

Constants

const (
	// ClusterServiceAnnounceStateChangeProcedure is the fully-qualified name of the ClusterService's
	// AnnounceStateChange RPC.
	ClusterServiceAnnounceStateChangeProcedure = "/cluster.v1.ClusterService/AnnounceStateChange"
)

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 (
	// ClusterServiceName is the fully-qualified name of the ClusterService service.
	ClusterServiceName = "cluster.v1.ClusterService"
)

Functions

func NewClusterServiceHandler

func NewClusterServiceHandler(svc ClusterServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewClusterServiceHandler 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 ClusterServiceClient

type ClusterServiceClient interface {
	// Announce that a node is changing state
	// When a node shuts down, it should announce that it is leaving the cluster, so other nodes can remove it from their view of the cluster as soon as possible.
	AnnounceStateChange(context.Context, *connect.Request[v1.AnnounceStateChangeRequest]) (*connect.Response[v1.AnnounceStateChangeResponse], error)
}

ClusterServiceClient is a client for the cluster.v1.ClusterService service.

func NewClusterServiceClient

func NewClusterServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ClusterServiceClient

NewClusterServiceClient constructs a client for the cluster.v1.ClusterService 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 ClusterServiceHandler

type ClusterServiceHandler interface {
	// Announce that a node is changing state
	// When a node shuts down, it should announce that it is leaving the cluster, so other nodes can remove it from their view of the cluster as soon as possible.
	AnnounceStateChange(context.Context, *connect.Request[v1.AnnounceStateChangeRequest]) (*connect.Response[v1.AnnounceStateChangeResponse], error)
}

ClusterServiceHandler is an implementation of the cluster.v1.ClusterService service.

type UnimplementedClusterServiceHandler

type UnimplementedClusterServiceHandler struct{}

UnimplementedClusterServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedClusterServiceHandler) AnnounceStateChange

func (UnimplementedClusterServiceHandler) AnnounceStateChange(context.Context, *connect.Request[v1.AnnounceStateChangeRequest]) (*connect.Response[v1.AnnounceStateChangeResponse], error)