settingsv1connect

Documentation

Index

• Constants
• func NewSettingsServiceHandler(svc SettingsServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• func RegisterSettingsServiceHandler(mux *mux.Router, svc SettingsServiceHandler, opts ...connect.HandlerOption)
• type SettingsServiceClient
  • func NewSettingsServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) SettingsServiceClient
• type SettingsServiceHandler
• type UnimplementedSettingsServiceHandler
  • func (UnimplementedSettingsServiceHandler) Get(context.Context, *connect.Request[v1.GetSettingsRequest]) (*connect.Response[v1.GetSettingsResponse], error)
  • func (UnimplementedSettingsServiceHandler) Set(context.Context, *connect.Request[v1.SetSettingsRequest]) (*connect.Response[v1.SetSettingsResponse], error)

Constants

const (
	// SettingsServiceGetProcedure is the fully-qualified name of the SettingsService's Get RPC.
	SettingsServiceGetProcedure = "/settings.v1.SettingsService/Get"
	// SettingsServiceSetProcedure is the fully-qualified name of the SettingsService's Set RPC.
	SettingsServiceSetProcedure = "/settings.v1.SettingsService/Set"
)

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 (
	// SettingsServiceName is the fully-qualified name of the SettingsService service.
	SettingsServiceName = "settings.v1.SettingsService"
)

Functions

func NewSettingsServiceHandler

func NewSettingsServiceHandler(svc SettingsServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewSettingsServiceHandler 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.

func RegisterSettingsServiceHandler

func RegisterSettingsServiceHandler(mux *mux.Router, svc SettingsServiceHandler, opts ...connect.HandlerOption)

RegisterSettingsServiceHandler register an HTTP handler to a mux.Router from the service implementation.

Types

type SettingsServiceClient

type SettingsServiceClient interface {
	Get(context.Context, *connect.Request[v1.GetSettingsRequest]) (*connect.Response[v1.GetSettingsResponse], error)
	Set(context.Context, *connect.Request[v1.SetSettingsRequest]) (*connect.Response[v1.SetSettingsResponse], error)
}

SettingsServiceClient is a client for the settings.v1.SettingsService service.

func NewSettingsServiceClient

func NewSettingsServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) SettingsServiceClient

NewSettingsServiceClient constructs a client for the settings.v1.SettingsService 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 SettingsServiceHandler

type SettingsServiceHandler interface {
	Get(context.Context, *connect.Request[v1.GetSettingsRequest]) (*connect.Response[v1.GetSettingsResponse], error)
	Set(context.Context, *connect.Request[v1.SetSettingsRequest]) (*connect.Response[v1.SetSettingsResponse], error)
}

SettingsServiceHandler is an implementation of the settings.v1.SettingsService service.

type UnimplementedSettingsServiceHandler

type UnimplementedSettingsServiceHandler struct{}

UnimplementedSettingsServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedSettingsServiceHandler) Get

func (UnimplementedSettingsServiceHandler) Get(context.Context, *connect.Request[v1.GetSettingsRequest]) (*connect.Response[v1.GetSettingsResponse], error)

func (UnimplementedSettingsServiceHandler) Set

func (UnimplementedSettingsServiceHandler) Set(context.Context, *connect.Request[v1.SetSettingsRequest]) (*connect.Response[v1.SetSettingsResponse], error)