versionv1connect

Documentation

Index

• Constants
• func NewVersionHandler(svc VersionHandler, opts ...connect.HandlerOption) (string, http.Handler)
• func RegisterVersionHandler(mux *mux.Router, svc VersionHandler, opts ...connect.HandlerOption)
• type UnimplementedVersionHandler
  • func (UnimplementedVersionHandler) Version(context.Context, *connect.Request[v1.VersionRequest]) (*connect.Response[v1.VersionResponse], error)
• type VersionClient
  • func NewVersionClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) VersionClient
• type VersionHandler

Constants

const (
	// VersionName is the fully-qualified name of the Version service.
	VersionName = "version.v1.Version"
)

const (
	// VersionVersionProcedure is the fully-qualified name of the Version's Version RPC.
	VersionVersionProcedure = "/version.v1.Version/Version"
)

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.

Functions

func NewVersionHandler

func NewVersionHandler(svc VersionHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewVersionHandler 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 RegisterVersionHandler

func RegisterVersionHandler(mux *mux.Router, svc VersionHandler, opts ...connect.HandlerOption)

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

Types

type UnimplementedVersionHandler

type UnimplementedVersionHandler struct{}

UnimplementedVersionHandler returns CodeUnimplemented from all methods.

func (UnimplementedVersionHandler) Version

func (UnimplementedVersionHandler) Version(context.Context, *connect.Request[v1.VersionRequest]) (*connect.Response[v1.VersionResponse], error)

type VersionClient

type VersionClient interface {
	Version(context.Context, *connect.Request[v1.VersionRequest]) (*connect.Response[v1.VersionResponse], error)
}

VersionClient is a client for the version.v1.Version service.

func NewVersionClient

func NewVersionClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) VersionClient

NewVersionClient constructs a client for the version.v1.Version 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 VersionHandler

type VersionHandler interface {
	Version(context.Context, *connect.Request[v1.VersionRequest]) (*connect.Response[v1.VersionResponse], error)
}

VersionHandler is an implementation of the version.v1.Version service.