Documentation
¶
Index ¶
- Constants
- func NewEntityServiceHandler(svc EntityServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type EntityServiceClient
- type EntityServiceHandler
- type UnimplementedEntityServiceHandler
- func (UnimplementedEntityServiceHandler) EntityById(context.Context, *connect.Request[v1.EntityByIdRequest]) (*connect.Response[v1.EntityByIdResponse], error)
- func (UnimplementedEntityServiceHandler) EntityList(context.Context, *connect.Request[v1.EntityListRequest]) (*connect.Response[v1.EntityListResponse], error)
- func (UnimplementedEntityServiceHandler) EventStream(context.Context, *connect.Request[v1.EventStreamRequest], ...) error
Constants ¶
const ( // EntityServiceEntityListProcedure is the fully-qualified name of the EntityService's EntityList // RPC. EntityServiceEntityListProcedure = "/entity.v1.EntityService/EntityList" // EntityServiceEntityByIdProcedure is the fully-qualified name of the EntityService's EntityById // RPC. EntityServiceEntityByIdProcedure = "/entity.v1.EntityService/EntityById" // EntityServiceEventStreamProcedure is the fully-qualified name of the EntityService's EventStream // RPC. EntityServiceEventStreamProcedure = "/entity.v1.EntityService/EventStream" )
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 (
// EntityServiceName is the fully-qualified name of the EntityService service.
EntityServiceName = "entity.v1.EntityService"
)
Variables ¶
This section is empty.
Functions ¶
func NewEntityServiceHandler ¶
func NewEntityServiceHandler(svc EntityServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewEntityServiceHandler 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 EntityServiceClient ¶
type EntityServiceClient interface {
EntityList(context.Context, *connect.Request[v1.EntityListRequest]) (*connect.Response[v1.EntityListResponse], error)
EntityById(context.Context, *connect.Request[v1.EntityByIdRequest]) (*connect.Response[v1.EntityByIdResponse], error)
EventStream(context.Context, *connect.Request[v1.EventStreamRequest]) (*connect.ServerStreamForClient[v1.EventStreamResponse], error)
}
EntityServiceClient is a client for the entity.v1.EntityService service.
func NewEntityServiceClient ¶
func NewEntityServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) EntityServiceClient
NewEntityServiceClient constructs a client for the entity.v1.EntityService 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 EntityServiceHandler ¶
type EntityServiceHandler interface {
EntityList(context.Context, *connect.Request[v1.EntityListRequest]) (*connect.Response[v1.EntityListResponse], error)
EntityById(context.Context, *connect.Request[v1.EntityByIdRequest]) (*connect.Response[v1.EntityByIdResponse], error)
EventStream(context.Context, *connect.Request[v1.EventStreamRequest], *connect.ServerStream[v1.EventStreamResponse]) error
}
EntityServiceHandler is an implementation of the entity.v1.EntityService service.
type UnimplementedEntityServiceHandler ¶
type UnimplementedEntityServiceHandler struct{}
UnimplementedEntityServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedEntityServiceHandler) EntityById ¶
func (UnimplementedEntityServiceHandler) EntityById(context.Context, *connect.Request[v1.EntityByIdRequest]) (*connect.Response[v1.EntityByIdResponse], error)
func (UnimplementedEntityServiceHandler) EntityList ¶
func (UnimplementedEntityServiceHandler) EntityList(context.Context, *connect.Request[v1.EntityListRequest]) (*connect.Response[v1.EntityListResponse], error)
func (UnimplementedEntityServiceHandler) EventStream ¶
func (UnimplementedEntityServiceHandler) EventStream(context.Context, *connect.Request[v1.EventStreamRequest], *connect.ServerStream[v1.EventStreamResponse]) error