Documentation
¶
Index ¶
- Constants
- func NewConsoleServiceHandler(svc ConsoleServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type ConsoleServiceClient
- type ConsoleServiceHandler
- type UnimplementedConsoleServiceHandler
- func (UnimplementedConsoleServiceHandler) GetEvents(context.Context, *connect.Request[console.EventsQuery]) (*connect.Response[console.GetEventsResponse], error)
- func (UnimplementedConsoleServiceHandler) GetModules(context.Context, *connect.Request[console.GetModulesRequest]) (*connect.Response[console.GetModulesResponse], error)
- func (UnimplementedConsoleServiceHandler) Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
- func (UnimplementedConsoleServiceHandler) StreamEvents(context.Context, *connect.Request[console.StreamEventsRequest], ...) error
Constants ¶
const ( // ConsoleServicePingProcedure is the fully-qualified name of the ConsoleService's Ping RPC. ConsoleServicePingProcedure = "/xyz.block.ftl.v1.console.ConsoleService/Ping" // ConsoleServiceGetModulesProcedure is the fully-qualified name of the ConsoleService's GetModules // RPC. ConsoleServiceGetModulesProcedure = "/xyz.block.ftl.v1.console.ConsoleService/GetModules" // ConsoleServiceStreamEventsProcedure is the fully-qualified name of the ConsoleService's // StreamEvents RPC. ConsoleServiceStreamEventsProcedure = "/xyz.block.ftl.v1.console.ConsoleService/StreamEvents" // ConsoleServiceGetEventsProcedure is the fully-qualified name of the ConsoleService's GetEvents // RPC. ConsoleServiceGetEventsProcedure = "/xyz.block.ftl.v1.console.ConsoleService/GetEvents" )
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 (
// ConsoleServiceName is the fully-qualified name of the ConsoleService service.
ConsoleServiceName = "xyz.block.ftl.v1.console.ConsoleService"
)
Variables ¶
This section is empty.
Functions ¶
func NewConsoleServiceHandler ¶
func NewConsoleServiceHandler(svc ConsoleServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewConsoleServiceHandler 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 ConsoleServiceClient ¶
type ConsoleServiceClient interface {
// Ping service for readiness.
Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
GetModules(context.Context, *connect.Request[console.GetModulesRequest]) (*connect.Response[console.GetModulesResponse], error)
StreamEvents(context.Context, *connect.Request[console.StreamEventsRequest]) (*connect.ServerStreamForClient[console.StreamEventsResponse], error)
GetEvents(context.Context, *connect.Request[console.EventsQuery]) (*connect.Response[console.GetEventsResponse], error)
}
ConsoleServiceClient is a client for the xyz.block.ftl.v1.console.ConsoleService service.
func NewConsoleServiceClient ¶
func NewConsoleServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ConsoleServiceClient
NewConsoleServiceClient constructs a client for the xyz.block.ftl.v1.console.ConsoleService 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 ConsoleServiceHandler ¶
type ConsoleServiceHandler interface {
// Ping service for readiness.
Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
GetModules(context.Context, *connect.Request[console.GetModulesRequest]) (*connect.Response[console.GetModulesResponse], error)
StreamEvents(context.Context, *connect.Request[console.StreamEventsRequest], *connect.ServerStream[console.StreamEventsResponse]) error
GetEvents(context.Context, *connect.Request[console.EventsQuery]) (*connect.Response[console.GetEventsResponse], error)
}
ConsoleServiceHandler is an implementation of the xyz.block.ftl.v1.console.ConsoleService service.
type UnimplementedConsoleServiceHandler ¶
type UnimplementedConsoleServiceHandler struct{}
UnimplementedConsoleServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedConsoleServiceHandler) GetEvents ¶
func (UnimplementedConsoleServiceHandler) GetEvents(context.Context, *connect.Request[console.EventsQuery]) (*connect.Response[console.GetEventsResponse], error)
func (UnimplementedConsoleServiceHandler) GetModules ¶
func (UnimplementedConsoleServiceHandler) GetModules(context.Context, *connect.Request[console.GetModulesRequest]) (*connect.Response[console.GetModulesResponse], error)
func (UnimplementedConsoleServiceHandler) Ping ¶
func (UnimplementedConsoleServiceHandler) Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
func (UnimplementedConsoleServiceHandler) StreamEvents ¶
func (UnimplementedConsoleServiceHandler) StreamEvents(context.Context, *connect.Request[console.StreamEventsRequest], *connect.ServerStream[console.StreamEventsResponse]) error
Source Files