ftlv1connect

Documentation

Index

• Constants
• func NewDeploymentServiceHandler(svc DeploymentServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type DeploymentServiceClient
  • func NewDeploymentServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) DeploymentServiceClient
• type DeploymentServiceHandler
• type UnimplementedDeploymentServiceHandler
  • func (UnimplementedDeploymentServiceHandler) GetDeploymentContext(context.Context, *connect.Request[v11.GetDeploymentContextRequest], ...) error
  • func (UnimplementedDeploymentServiceHandler) Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
  • func (UnimplementedDeploymentServiceHandler) PublishEvent(context.Context, *connect.Request[v11.PublishEventRequest]) (*connect.Response[v11.PublishEventResponse], error)

Constants

const (
	// DeploymentServicePingProcedure is the fully-qualified name of the DeploymentService's Ping RPC.
	DeploymentServicePingProcedure = "/xyz.block.ftl.deployment.v1.DeploymentService/Ping"
	// DeploymentServiceGetDeploymentContextProcedure is the fully-qualified name of the
	// DeploymentService's GetDeploymentContext RPC.
	DeploymentServiceGetDeploymentContextProcedure = "/xyz.block.ftl.deployment.v1.DeploymentService/GetDeploymentContext"
	// DeploymentServicePublishEventProcedure is the fully-qualified name of the DeploymentService's
	// PublishEvent RPC.
	DeploymentServicePublishEventProcedure = "/xyz.block.ftl.deployment.v1.DeploymentService/PublishEvent"
)

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 (
	// DeploymentServiceName is the fully-qualified name of the DeploymentService service.
	DeploymentServiceName = "xyz.block.ftl.deployment.v1.DeploymentService"
)

Functions

func NewDeploymentServiceHandler

func NewDeploymentServiceHandler(svc DeploymentServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewDeploymentServiceHandler 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 DeploymentServiceClient

type DeploymentServiceClient interface {
	// Ping service for readiness.
	Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
	// Get configuration state for the deployment
	GetDeploymentContext(context.Context, *connect.Request[v11.GetDeploymentContextRequest]) (*connect.ServerStreamForClient[v11.GetDeploymentContextResponse], error)
	// Publish an event to a topic.
	PublishEvent(context.Context, *connect.Request[v11.PublishEventRequest]) (*connect.Response[v11.PublishEventResponse], error)
}

DeploymentServiceClient is a client for the xyz.block.ftl.deployment.v1.DeploymentService service.

func NewDeploymentServiceClient

func NewDeploymentServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) DeploymentServiceClient

NewDeploymentServiceClient constructs a client for the xyz.block.ftl.deployment.v1.DeploymentService 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 DeploymentServiceHandler

type DeploymentServiceHandler interface {
	// Ping service for readiness.
	Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
	// Get configuration state for the deployment
	GetDeploymentContext(context.Context, *connect.Request[v11.GetDeploymentContextRequest], *connect.ServerStream[v11.GetDeploymentContextResponse]) error
	// Publish an event to a topic.
	PublishEvent(context.Context, *connect.Request[v11.PublishEventRequest]) (*connect.Response[v11.PublishEventResponse], error)
}

DeploymentServiceHandler is an implementation of the xyz.block.ftl.deployment.v1.DeploymentService service.

type UnimplementedDeploymentServiceHandler

type UnimplementedDeploymentServiceHandler struct{}

UnimplementedDeploymentServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedDeploymentServiceHandler) GetDeploymentContext

func (UnimplementedDeploymentServiceHandler) GetDeploymentContext(context.Context, *connect.Request[v11.GetDeploymentContextRequest], *connect.ServerStream[v11.GetDeploymentContextResponse]) error

func (UnimplementedDeploymentServiceHandler) Ping

func (UnimplementedDeploymentServiceHandler) Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)

func (UnimplementedDeploymentServiceHandler) PublishEvent

func (UnimplementedDeploymentServiceHandler) PublishEvent(context.Context, *connect.Request[v11.PublishEventRequest]) (*connect.Response[v11.PublishEventResponse], error)