hotreloadpbconnect

Documentation

Index

• Constants
• func NewHotReloadServiceHandler(svc HotReloadServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type HotReloadServiceClient
  • func NewHotReloadServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) HotReloadServiceClient
• type HotReloadServiceHandler
• type UnimplementedHotReloadServiceHandler
  • func (UnimplementedHotReloadServiceHandler) Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
  • func (UnimplementedHotReloadServiceHandler) Reload(context.Context, *connect.Request[v11.ReloadRequest]) (*connect.Response[v11.ReloadResponse], error)
  • func (UnimplementedHotReloadServiceHandler) RunnerInfo(context.Context, *connect.Request[v11.RunnerInfoRequest]) (*connect.Response[v11.RunnerInfoResponse], error)
  • func (UnimplementedHotReloadServiceHandler) Watch(context.Context, *connect.Request[v11.WatchRequest], ...) error

Constants

const (
	// HotReloadServicePingProcedure is the fully-qualified name of the HotReloadService's Ping RPC.
	HotReloadServicePingProcedure = "/xyz.block.ftl.hotreload.v1.HotReloadService/Ping"
	// HotReloadServiceReloadProcedure is the fully-qualified name of the HotReloadService's Reload RPC.
	HotReloadServiceReloadProcedure = "/xyz.block.ftl.hotreload.v1.HotReloadService/Reload"
	// HotReloadServiceWatchProcedure is the fully-qualified name of the HotReloadService's Watch RPC.
	HotReloadServiceWatchProcedure = "/xyz.block.ftl.hotreload.v1.HotReloadService/Watch"
	// HotReloadServiceRunnerInfoProcedure is the fully-qualified name of the HotReloadService's
	// RunnerInfo RPC.
	HotReloadServiceRunnerInfoProcedure = "/xyz.block.ftl.hotreload.v1.HotReloadService/RunnerInfo"
)

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

Functions

func NewHotReloadServiceHandler

func NewHotReloadServiceHandler(svc HotReloadServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewHotReloadServiceHandler 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 HotReloadServiceClient

type HotReloadServiceClient interface {
	// Ping service for readiness.
	Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
	// Forces an explicit Reload from the plugin. This is useful for when the plugin needs to trigger a Reload,
	// such as when the Reload context changes.
	Reload(context.Context, *connect.Request[v11.ReloadRequest]) (*connect.Response[v11.ReloadResponse], error)
	// Watch for hot reloads not initiated by an explicit Reload call.
	Watch(context.Context, *connect.Request[v11.WatchRequest]) (*connect.ServerStreamForClient[v11.WatchResponse], error)
	// Invoked by the runner to provide runner information to the plugin.
	RunnerInfo(context.Context, *connect.Request[v11.RunnerInfoRequest]) (*connect.Response[v11.RunnerInfoResponse], error)
}

HotReloadServiceClient is a client for the xyz.block.ftl.hotreload.v1.HotReloadService service.

func NewHotReloadServiceClient

func NewHotReloadServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) HotReloadServiceClient

NewHotReloadServiceClient constructs a client for the xyz.block.ftl.hotreload.v1.HotReloadService 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 HotReloadServiceHandler

type HotReloadServiceHandler interface {
	// Ping service for readiness.
	Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
	// Forces an explicit Reload from the plugin. This is useful for when the plugin needs to trigger a Reload,
	// such as when the Reload context changes.
	Reload(context.Context, *connect.Request[v11.ReloadRequest]) (*connect.Response[v11.ReloadResponse], error)
	// Watch for hot reloads not initiated by an explicit Reload call.
	Watch(context.Context, *connect.Request[v11.WatchRequest], *connect.ServerStream[v11.WatchResponse]) error
	// Invoked by the runner to provide runner information to the plugin.
	RunnerInfo(context.Context, *connect.Request[v11.RunnerInfoRequest]) (*connect.Response[v11.RunnerInfoResponse], error)
}

HotReloadServiceHandler is an implementation of the xyz.block.ftl.hotreload.v1.HotReloadService service.

type UnimplementedHotReloadServiceHandler

type UnimplementedHotReloadServiceHandler struct{}

UnimplementedHotReloadServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedHotReloadServiceHandler) Ping

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

func (UnimplementedHotReloadServiceHandler) Reload

func (UnimplementedHotReloadServiceHandler) Reload(context.Context, *connect.Request[v11.ReloadRequest]) (*connect.Response[v11.ReloadResponse], error)

func (UnimplementedHotReloadServiceHandler) RunnerInfo

func (UnimplementedHotReloadServiceHandler) RunnerInfo(context.Context, *connect.Request[v11.RunnerInfoRequest]) (*connect.Response[v11.RunnerInfoResponse], error)

func (UnimplementedHotReloadServiceHandler) Watch

func (UnimplementedHotReloadServiceHandler) Watch(context.Context, *connect.Request[v11.WatchRequest], *connect.ServerStream[v11.WatchResponse]) error