buildenginepbconnect

Documentation

Index

• Constants
• func NewBuildEngineServiceHandler(svc BuildEngineServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type BuildEngineServiceClient
  • func NewBuildEngineServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) BuildEngineServiceClient
• type BuildEngineServiceHandler
• type UnimplementedBuildEngineServiceHandler
  • func (UnimplementedBuildEngineServiceHandler) Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
  • func (UnimplementedBuildEngineServiceHandler) StreamEngineEvents(context.Context, *connect.Request[v11.StreamEngineEventsRequest], ...) error

Constants

const (
	// BuildEngineServicePingProcedure is the fully-qualified name of the BuildEngineService's Ping RPC.
	BuildEngineServicePingProcedure = "/xyz.block.ftl.buildengine.v1.BuildEngineService/Ping"
	// BuildEngineServiceStreamEngineEventsProcedure is the fully-qualified name of the
	// BuildEngineService's StreamEngineEvents RPC.
	BuildEngineServiceStreamEngineEventsProcedure = "/xyz.block.ftl.buildengine.v1.BuildEngineService/StreamEngineEvents"
)

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

Functions

func NewBuildEngineServiceHandler

func NewBuildEngineServiceHandler(svc BuildEngineServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewBuildEngineServiceHandler 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 BuildEngineServiceClient

type BuildEngineServiceClient interface {
	// Ping service for readiness.
	Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
	StreamEngineEvents(context.Context, *connect.Request[v11.StreamEngineEventsRequest]) (*connect.ServerStreamForClient[v11.StreamEngineEventsResponse], error)
}

BuildEngineServiceClient is a client for the xyz.block.ftl.buildengine.v1.BuildEngineService service.

func NewBuildEngineServiceClient

func NewBuildEngineServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) BuildEngineServiceClient

NewBuildEngineServiceClient constructs a client for the xyz.block.ftl.buildengine.v1.BuildEngineService 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 BuildEngineServiceHandler

type BuildEngineServiceHandler interface {
	// Ping service for readiness.
	Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
	StreamEngineEvents(context.Context, *connect.Request[v11.StreamEngineEventsRequest], *connect.ServerStream[v11.StreamEngineEventsResponse]) error
}

BuildEngineServiceHandler is an implementation of the xyz.block.ftl.buildengine.v1.BuildEngineService service.

type UnimplementedBuildEngineServiceHandler

type UnimplementedBuildEngineServiceHandler struct{}

UnimplementedBuildEngineServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedBuildEngineServiceHandler) Ping

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

func (UnimplementedBuildEngineServiceHandler) StreamEngineEvents

func (UnimplementedBuildEngineServiceHandler) StreamEngineEvents(context.Context, *connect.Request[v11.StreamEngineEventsRequest], *connect.ServerStream[v11.StreamEngineEventsResponse]) error