v1connect

Documentation

Index

• Constants
• func NewGreeterServiceHandler(svc GreeterServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type GreeterServiceClient
  • func NewGreeterServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) GreeterServiceClient
• type GreeterServiceHandler
• type UnimplementedGreeterServiceHandler
  • func (UnimplementedGreeterServiceHandler) Hello(context.Context, *connect.Request[v1.HelloRequest]) (*connect.Response[v1.HelloResponse], error)
  • func (UnimplementedGreeterServiceHandler) Sign(context.Context, *connect.Request[v1.SignRequest]) (*connect.Response[v1.SignResponse], error)

Constants

const (
	// GreeterServiceHelloProcedure is the fully-qualified name of the GreeterService's Hello RPC.
	GreeterServiceHelloProcedure = "/api.rpc.v1.GreeterService/Hello"
	// GreeterServiceSignProcedure is the fully-qualified name of the GreeterService's Sign RPC.
	GreeterServiceSignProcedure = "/api.rpc.v1.GreeterService/Sign"
)

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 (
	// GreeterServiceName is the fully-qualified name of the GreeterService service.
	GreeterServiceName = "api.rpc.v1.GreeterService"
)

Functions

func NewGreeterServiceHandler

func NewGreeterServiceHandler(svc GreeterServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewGreeterServiceHandler 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 GreeterServiceClient

type GreeterServiceClient interface {
	Hello(context.Context, *connect.Request[v1.HelloRequest]) (*connect.Response[v1.HelloResponse], error)
	Sign(context.Context, *connect.Request[v1.SignRequest]) (*connect.Response[v1.SignResponse], error)
}

GreeterServiceClient is a client for the api.rpc.v1.GreeterService service.

func NewGreeterServiceClient

func NewGreeterServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) GreeterServiceClient

NewGreeterServiceClient constructs a client for the api.rpc.v1.GreeterService 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 GreeterServiceHandler

type GreeterServiceHandler interface {
	Hello(context.Context, *connect.Request[v1.HelloRequest]) (*connect.Response[v1.HelloResponse], error)
	Sign(context.Context, *connect.Request[v1.SignRequest]) (*connect.Response[v1.SignResponse], error)
}

GreeterServiceHandler is an implementation of the api.rpc.v1.GreeterService service.

type UnimplementedGreeterServiceHandler

type UnimplementedGreeterServiceHandler struct{}

UnimplementedGreeterServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedGreeterServiceHandler) Hello

func (UnimplementedGreeterServiceHandler) Hello(context.Context, *connect.Request[v1.HelloRequest]) (*connect.Response[v1.HelloResponse], error)

func (UnimplementedGreeterServiceHandler) Sign

func (UnimplementedGreeterServiceHandler) Sign(context.Context, *connect.Request[v1.SignRequest]) (*connect.Response[v1.SignResponse], error)