protoconnect

Documentation

Overview

Generate with protoc --go_out=. echo.proto -I /work/common-protos/ -I.

Index

• Constants
• func NewEchoTestServiceHandler(svc EchoTestServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type EchoTestServiceClient
  • func NewEchoTestServiceClient(httpClient connect_go.HTTPClient, baseURL string, ...) EchoTestServiceClient
• type EchoTestServiceHandler
• type UnimplementedEchoTestServiceHandler
  • func (UnimplementedEchoTestServiceHandler) Echo(context.Context, *connect_go.Request[proto.EchoRequest]) (*connect_go.Response[proto.EchoResponse], error)
  • func (UnimplementedEchoTestServiceHandler) ForwardEcho(context.Context, *connect_go.Request[proto.ForwardEchoRequest]) (*connect_go.Response[proto.ForwardEchoResponse], error)

Constants

const (
	// EchoTestServiceEchoProcedure is the fully-qualified name of the EchoTestService's Echo RPC.
	EchoTestServiceEchoProcedure = "/proto.EchoTestService/Echo"
	// EchoTestServiceForwardEchoProcedure is the fully-qualified name of the EchoTestService's
	// ForwardEcho RPC.
	EchoTestServiceForwardEchoProcedure = "/proto.EchoTestService/ForwardEcho"
)

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 (
	// EchoTestServiceName is the fully-qualified name of the EchoTestService service.
	EchoTestServiceName = "proto.EchoTestService"
)

Functions

func NewEchoTestServiceHandler

func NewEchoTestServiceHandler(svc EchoTestServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewEchoTestServiceHandler 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 EchoTestServiceClient

type EchoTestServiceClient interface {
	Echo(context.Context, *connect_go.Request[proto.EchoRequest]) (*connect_go.Response[proto.EchoResponse], error)
	ForwardEcho(context.Context, *connect_go.Request[proto.ForwardEchoRequest]) (*connect_go.Response[proto.ForwardEchoResponse], error)
}

EchoTestServiceClient is a client for the proto.EchoTestService service.

func NewEchoTestServiceClient

func NewEchoTestServiceClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) EchoTestServiceClient

NewEchoTestServiceClient constructs a client for the proto.EchoTestService 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 EchoTestServiceHandler

type EchoTestServiceHandler interface {
	Echo(context.Context, *connect_go.Request[proto.EchoRequest]) (*connect_go.Response[proto.EchoResponse], error)
	ForwardEcho(context.Context, *connect_go.Request[proto.ForwardEchoRequest]) (*connect_go.Response[proto.ForwardEchoResponse], error)
}

EchoTestServiceHandler is an implementation of the proto.EchoTestService service.

type UnimplementedEchoTestServiceHandler

type UnimplementedEchoTestServiceHandler struct{}

UnimplementedEchoTestServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedEchoTestServiceHandler) Echo

func (UnimplementedEchoTestServiceHandler) Echo(context.Context, *connect_go.Request[proto.EchoRequest]) (*connect_go.Response[proto.EchoResponse], error)

func (UnimplementedEchoTestServiceHandler) ForwardEcho

func (UnimplementedEchoTestServiceHandler) ForwardEcho(context.Context, *connect_go.Request[proto.ForwardEchoRequest]) (*connect_go.Response[proto.ForwardEchoResponse], error)