httpgrpcconnect

Documentation

Index

• Constants
• func NewHTTPHandler(svc HTTPHandler, opts ...connect.HandlerOption) (string, http.Handler)
• func RegisterHTTPHandler(mux *mux.Router, svc HTTPHandler, opts ...connect.HandlerOption)
• type HTTPClient
  • func NewHTTPClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) HTTPClient
• type HTTPHandler
• type UnimplementedHTTPHandler
  • func (UnimplementedHTTPHandler) Handle(context.Context, *connect.Request[httpgrpc.HTTPRequest]) (*connect.Response[httpgrpc.HTTPResponse], error)

Constants

const (
	// HTTPHandleProcedure is the fully-qualified name of the HTTP's Handle RPC.
	HTTPHandleProcedure = "/httpgrpc.HTTP/Handle"
)

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 (
	// HTTPName is the fully-qualified name of the HTTP service.
	HTTPName = "httpgrpc.HTTP"
)

Functions

func NewHTTPHandler

func NewHTTPHandler(svc HTTPHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewHTTPHandler 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 RegisterHTTPHandler

func RegisterHTTPHandler(mux *mux.Router, svc HTTPHandler, opts ...connect.HandlerOption)

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

Types

type HTTPClient

type HTTPClient interface {
	Handle(context.Context, *connect.Request[httpgrpc.HTTPRequest]) (*connect.Response[httpgrpc.HTTPResponse], error)
}

HTTPClient is a client for the httpgrpc.HTTP service.

func NewHTTPClient

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

NewHTTPClient constructs a client for the httpgrpc.HTTP 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 HTTPHandler

type HTTPHandler interface {
	Handle(context.Context, *connect.Request[httpgrpc.HTTPRequest]) (*connect.Response[httpgrpc.HTTPResponse], error)
}

HTTPHandler is an implementation of the httpgrpc.HTTP service.

type UnimplementedHTTPHandler

type UnimplementedHTTPHandler struct{}

UnimplementedHTTPHandler returns CodeUnimplemented from all methods.

func (UnimplementedHTTPHandler) Handle

func (UnimplementedHTTPHandler) Handle(context.Context, *connect.Request[httpgrpc.HTTPRequest]) (*connect.Response[httpgrpc.HTTPResponse], error)