coordinatorconnect

Documentation

Overview

Namespace for the coordinator service The fn0rd.coordinator.v1 package contains definitions for the distributed computation coordination system

Index

• Constants
• func NewCoordinatorServiceHandler(svc CoordinatorServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type CoordinatorServiceClient
  • func NewCoordinatorServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) CoordinatorServiceClient
• type CoordinatorServiceHandler
• type UnimplementedCoordinatorServiceHandler
  • func (UnimplementedCoordinatorServiceHandler) Stream(context.Context, *connect.BidiStream[v1.StreamRequest, v1.StreamResponse]) error

Constants

const (
	// CoordinatorServiceName is the fully-qualified name of the CoordinatorService service.
	CoordinatorServiceName = "fn0rd.coordinator.v1.CoordinatorService"
)

const (
	// CoordinatorServiceStreamProcedure is the fully-qualified name of the CoordinatorService's Stream
	// RPC.
	CoordinatorServiceStreamProcedure = "/fn0rd.coordinator.v1.CoordinatorService/Stream"
)

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.

Functions

func NewCoordinatorServiceHandler

func NewCoordinatorServiceHandler(svc CoordinatorServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewCoordinatorServiceHandler 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 CoordinatorServiceClient

type CoordinatorServiceClient interface {
	// Stream establishes a bidirectional connection between client and coordinator
	// Clients can send registration and result submission messages
	// The coordinator can send computational targets and other control messages
	Stream(context.Context) *connect.BidiStreamForClient[v1.StreamRequest, v1.StreamResponse]
}

CoordinatorServiceClient is a client for the fn0rd.coordinator.v1.CoordinatorService service.

func NewCoordinatorServiceClient

func NewCoordinatorServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) CoordinatorServiceClient

NewCoordinatorServiceClient constructs a client for the fn0rd.coordinator.v1.CoordinatorService 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 CoordinatorServiceHandler

type CoordinatorServiceHandler interface {
	// Stream establishes a bidirectional connection between client and coordinator
	// Clients can send registration and result submission messages
	// The coordinator can send computational targets and other control messages
	Stream(context.Context, *connect.BidiStream[v1.StreamRequest, v1.StreamResponse]) error
}

CoordinatorServiceHandler is an implementation of the fn0rd.coordinator.v1.CoordinatorService service.

type UnimplementedCoordinatorServiceHandler

type UnimplementedCoordinatorServiceHandler struct{}

UnimplementedCoordinatorServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedCoordinatorServiceHandler) Stream

func (UnimplementedCoordinatorServiceHandler) Stream(context.Context, *connect.BidiStream[v1.StreamRequest, v1.StreamResponse]) error