Documentation
¶
Index ¶
- Constants
- func NewConfigServiceHandler(svc ConfigServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type ConfigServiceClient
- type ConfigServiceHandler
- type UnimplementedConfigServiceHandler
- func (UnimplementedConfigServiceHandler) Commit(context.Context, *connect.Request[v1.Config]) (*connect.Response[v1.Empty], error)
- func (UnimplementedConfigServiceHandler) Do(context.Context, *connect.Request[v1.Op]) (*connect.Response[v1.Return], error)
- func (UnimplementedConfigServiceHandler) Download(context.Context, *connect.Request[v1.BundleConfig], ...) error
- func (UnimplementedConfigServiceHandler) Free(context.Context, *connect.Request[v1.Config]) (*connect.Response[v1.Empty], error)
- func (UnimplementedConfigServiceHandler) Load(context.Context, *connect.Request[v1.Source]) (*connect.Response[v1.Config], error)
- func (UnimplementedConfigServiceHandler) New(context.Context, *connect.Request[v1.Empty]) (*connect.Response[v1.Config], error)
- func (UnimplementedConfigServiceHandler) Upload(context.Context, *connect.ClientStream[v1.SourceUpload]) (*connect.Response[v1.Config], error)
Constants ¶
const ( // ConfigServiceNewProcedure is the fully-qualified name of the ConfigService's New RPC. ConfigServiceNewProcedure = "/config.v1.ConfigService/New" // ConfigServiceLoadProcedure is the fully-qualified name of the ConfigService's Load RPC. ConfigServiceLoadProcedure = "/config.v1.ConfigService/Load" // ConfigServiceUploadProcedure is the fully-qualified name of the ConfigService's Upload RPC. ConfigServiceUploadProcedure = "/config.v1.ConfigService/Upload" // ConfigServiceDownloadProcedure is the fully-qualified name of the ConfigService's Download RPC. ConfigServiceDownloadProcedure = "/config.v1.ConfigService/Download" // ConfigServiceCommitProcedure is the fully-qualified name of the ConfigService's Commit RPC. ConfigServiceCommitProcedure = "/config.v1.ConfigService/Commit" // ConfigServiceFreeProcedure is the fully-qualified name of the ConfigService's Free RPC. ConfigServiceFreeProcedure = "/config.v1.ConfigService/Free" // ConfigServiceDoProcedure is the fully-qualified name of the ConfigService's Do RPC. ConfigServiceDoProcedure = "/config.v1.ConfigService/Do" )
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 (
// ConfigServiceName is the fully-qualified name of the ConfigService service.
ConfigServiceName = "config.v1.ConfigService"
)
Variables ¶
This section is empty.
Functions ¶
func NewConfigServiceHandler ¶
func NewConfigServiceHandler(svc ConfigServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewConfigServiceHandler 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 ConfigServiceClient ¶
type ConfigServiceClient interface {
New(context.Context, *connect.Request[v1.Empty]) (*connect.Response[v1.Config], error)
Load(context.Context, *connect.Request[v1.Source]) (*connect.Response[v1.Config], error)
Upload(context.Context) *connect.ClientStreamForClient[v1.SourceUpload, v1.Config]
Download(context.Context, *connect.Request[v1.BundleConfig]) (*connect.ServerStreamForClient[v1.Bundle], error)
Commit(context.Context, *connect.Request[v1.Config]) (*connect.Response[v1.Empty], error)
Free(context.Context, *connect.Request[v1.Config]) (*connect.Response[v1.Empty], error)
Do(context.Context, *connect.Request[v1.Op]) (*connect.Response[v1.Return], error)
}
ConfigServiceClient is a client for the config.v1.ConfigService service.
func NewConfigServiceClient ¶
func NewConfigServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ConfigServiceClient
NewConfigServiceClient constructs a client for the config.v1.ConfigService 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 ConfigServiceHandler ¶
type ConfigServiceHandler interface {
New(context.Context, *connect.Request[v1.Empty]) (*connect.Response[v1.Config], error)
Load(context.Context, *connect.Request[v1.Source]) (*connect.Response[v1.Config], error)
Upload(context.Context, *connect.ClientStream[v1.SourceUpload]) (*connect.Response[v1.Config], error)
Download(context.Context, *connect.Request[v1.BundleConfig], *connect.ServerStream[v1.Bundle]) error
Commit(context.Context, *connect.Request[v1.Config]) (*connect.Response[v1.Empty], error)
Free(context.Context, *connect.Request[v1.Config]) (*connect.Response[v1.Empty], error)
Do(context.Context, *connect.Request[v1.Op]) (*connect.Response[v1.Return], error)
}
ConfigServiceHandler is an implementation of the config.v1.ConfigService service.
type UnimplementedConfigServiceHandler ¶
type UnimplementedConfigServiceHandler struct{}
UnimplementedConfigServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedConfigServiceHandler) Download ¶
func (UnimplementedConfigServiceHandler) Download(context.Context, *connect.Request[v1.BundleConfig], *connect.ServerStream[v1.Bundle]) error
func (UnimplementedConfigServiceHandler) Upload ¶
func (UnimplementedConfigServiceHandler) Upload(context.Context, *connect.ClientStream[v1.SourceUpload]) (*connect.Response[v1.Config], error)
Source Files