v1connect

Documentation

Index

• Constants
• func NewEchoServiceHandler(svc EchoServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type EchoServiceClient
  • func NewEchoServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) EchoServiceClient
• type EchoServiceHandler
• type UnimplementedEchoServiceHandler
  • func (UnimplementedEchoServiceHandler) Speak(context.Context, *connect.Request[v1.SpeakRequest]) (*connect.Response[v1.SpeakResponse], error)

Constants

const (
	// EchoServiceName is the fully-qualified name of the EchoService service.
	EchoServiceName = "examples.echo.v1.EchoService"
)

const (
	// EchoServiceSpeakProcedure is the fully-qualified name of the EchoService's Speak RPC.
	EchoServiceSpeakProcedure = "/examples.echo.v1.EchoService/Speak"
)

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 NewEchoServiceHandler

func NewEchoServiceHandler(svc EchoServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewEchoServiceHandler 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 EchoServiceClient

type EchoServiceClient interface {
	Speak(context.Context, *connect.Request[v1.SpeakRequest]) (*connect.Response[v1.SpeakResponse], error)
}

EchoServiceClient is a client for the examples.echo.v1.EchoService service.

func NewEchoServiceClient

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

NewEchoServiceClient constructs a client for the examples.echo.v1.EchoService 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 EchoServiceHandler

type EchoServiceHandler interface {
	Speak(context.Context, *connect.Request[v1.SpeakRequest]) (*connect.Response[v1.SpeakResponse], error)
}

EchoServiceHandler is an implementation of the examples.echo.v1.EchoService service.

type UnimplementedEchoServiceHandler

type UnimplementedEchoServiceHandler struct{}

UnimplementedEchoServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedEchoServiceHandler) Speak

func (UnimplementedEchoServiceHandler) Speak(context.Context, *connect.Request[v1.SpeakRequest]) (*connect.Response[v1.SpeakResponse], error)