demov1connect

Documentation

Index

• Constants
• func NewPetAPIHandler(svc PetAPIHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type PetAPIClient
  • func NewPetAPIClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) PetAPIClient
• type PetAPIHandler
• type UnimplementedPetAPIHandler
  • func (UnimplementedPetAPIHandler) GetPet(context.Context, *connect.Request[v1.GetPetRequest]) (*connect.Response[v1.GetPetResponse], error)
  • func (UnimplementedPetAPIHandler) Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)

Constants

const (
	// PetAPIGetPetProcedure is the fully-qualified name of the PetAPI's GetPet RPC.
	PetAPIGetPetProcedure = "/demo.v1.PetAPI/GetPet"
	// PetAPIPingProcedure is the fully-qualified name of the PetAPI's Ping RPC.
	PetAPIPingProcedure = "/demo.v1.PetAPI/Ping"
)

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 (
	// PetAPIName is the fully-qualified name of the PetAPI service.
	PetAPIName = "demo.v1.PetAPI"
)

Functions

func NewPetAPIHandler

func NewPetAPIHandler(svc PetAPIHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewPetAPIHandler 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 PetAPIClient

type PetAPIClient interface {
	GetPet(context.Context, *connect.Request[v1.GetPetRequest]) (*connect.Response[v1.GetPetResponse], error)
	Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
}

PetAPIClient is a client for the demo.v1.PetAPI service.

func NewPetAPIClient

func NewPetAPIClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) PetAPIClient

NewPetAPIClient constructs a client for the demo.v1.PetAPI 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 PetAPIHandler

type PetAPIHandler interface {
	GetPet(context.Context, *connect.Request[v1.GetPetRequest]) (*connect.Response[v1.GetPetResponse], error)
	Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
}

PetAPIHandler is an implementation of the demo.v1.PetAPI service.

type UnimplementedPetAPIHandler

type UnimplementedPetAPIHandler struct{}

UnimplementedPetAPIHandler returns CodeUnimplemented from all methods.

func (UnimplementedPetAPIHandler) GetPet

func (UnimplementedPetAPIHandler) GetPet(context.Context, *connect.Request[v1.GetPetRequest]) (*connect.Response[v1.GetPetResponse], error)

func (UnimplementedPetAPIHandler) Ping

func (UnimplementedPetAPIHandler) Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)