v1connect

Documentation

Index

• Constants
• func NewRaftServiceHandler(svc RaftServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type RaftServiceClient
  • func NewRaftServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) RaftServiceClient
• type RaftServiceHandler
• type UnimplementedRaftServiceHandler
  • func (UnimplementedRaftServiceHandler) Join(context.Context, *connect.Request[v1.JoinRequest]) (*connect.Response[v1.JoinResponse], error)
  • func (UnimplementedRaftServiceHandler) Remove(context.Context, *connect.Request[v1.RemoveRequest]) (*connect.Response[v1.RemoveResponse], error)
  • func (UnimplementedRaftServiceHandler) Stats(context.Context, *connect.Request[v1.StatsRequest]) (*connect.Response[v1.StatsResponse], error)

Constants

const (
	// RaftServiceJoinProcedure is the fully-qualified name of the RaftService's Join RPC.
	RaftServiceJoinProcedure = "/core.consensus.raft.v1.RaftService/Join"
	// RaftServiceRemoveProcedure is the fully-qualified name of the RaftService's Remove RPC.
	RaftServiceRemoveProcedure = "/core.consensus.raft.v1.RaftService/Remove"
	// RaftServiceStatsProcedure is the fully-qualified name of the RaftService's Stats RPC.
	RaftServiceStatsProcedure = "/core.consensus.raft.v1.RaftService/Stats"
)

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 (
	// RaftServiceName is the fully-qualified name of the RaftService service.
	RaftServiceName = "core.consensus.raft.v1.RaftService"
)

Functions

func NewRaftServiceHandler

func NewRaftServiceHandler(svc RaftServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewRaftServiceHandler 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 RaftServiceClient

type RaftServiceClient interface {
	// Join the raft cluster
	Join(context.Context, *connect.Request[v1.JoinRequest]) (*connect.Response[v1.JoinResponse], error)
	// Leave the raft cluster
	Remove(context.Context, *connect.Request[v1.RemoveRequest]) (*connect.Response[v1.RemoveResponse], error)
	// Gather raft cluster stats
	Stats(context.Context, *connect.Request[v1.StatsRequest]) (*connect.Response[v1.StatsResponse], error)
}

RaftServiceClient is a client for the core.consensus.raft.v1.RaftService service.

func NewRaftServiceClient

func NewRaftServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) RaftServiceClient

NewRaftServiceClient constructs a client for the core.consensus.raft.v1.RaftService 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 RaftServiceHandler

type RaftServiceHandler interface {
	// Join the raft cluster
	Join(context.Context, *connect.Request[v1.JoinRequest]) (*connect.Response[v1.JoinResponse], error)
	// Leave the raft cluster
	Remove(context.Context, *connect.Request[v1.RemoveRequest]) (*connect.Response[v1.RemoveResponse], error)
	// Gather raft cluster stats
	Stats(context.Context, *connect.Request[v1.StatsRequest]) (*connect.Response[v1.StatsResponse], error)
}

RaftServiceHandler is an implementation of the core.consensus.raft.v1.RaftService service.

type UnimplementedRaftServiceHandler

type UnimplementedRaftServiceHandler struct{}

UnimplementedRaftServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedRaftServiceHandler) Join

func (UnimplementedRaftServiceHandler) Join(context.Context, *connect.Request[v1.JoinRequest]) (*connect.Response[v1.JoinResponse], error)

func (UnimplementedRaftServiceHandler) Remove

func (UnimplementedRaftServiceHandler) Remove(context.Context, *connect.Request[v1.RemoveRequest]) (*connect.Response[v1.RemoveResponse], error)

func (UnimplementedRaftServiceHandler) Stats

func (UnimplementedRaftServiceHandler) Stats(context.Context, *connect.Request[v1.StatsRequest]) (*connect.Response[v1.StatsResponse], error)