examplesconnect

Documentation

Index

• Constants
• func NewGreeterHandler(svc GreeterHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type GreeterClient
  • func NewGreeterClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) GreeterClient
• type GreeterHandler
• type UnimplementedGreeterHandler
  • func (UnimplementedGreeterHandler) SayHello(context.Context, *connect.Request[examples.HelloRequest]) (*connect.Response[examples.HelloReply], error)

Constants

const (
	// GreeterName is the fully-qualified name of the Greeter service.
	GreeterName = "helloworld.Greeter"
)

const (
	// GreeterSayHelloProcedure is the fully-qualified name of the Greeter's SayHello RPC.
	GreeterSayHelloProcedure = "/helloworld.Greeter/SayHello"
)

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 NewGreeterHandler

func NewGreeterHandler(svc GreeterHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewGreeterHandler 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 GreeterClient

type GreeterClient interface {
	// Sends a greeting
	SayHello(context.Context, *connect.Request[examples.HelloRequest]) (*connect.Response[examples.HelloReply], error)
}

GreeterClient is a client for the helloworld.Greeter service.

func NewGreeterClient

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

NewGreeterClient constructs a client for the helloworld.Greeter 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 GreeterHandler

type GreeterHandler interface {
	// Sends a greeting
	SayHello(context.Context, *connect.Request[examples.HelloRequest]) (*connect.Response[examples.HelloReply], error)
}

GreeterHandler is an implementation of the helloworld.Greeter service.

type UnimplementedGreeterHandler

type UnimplementedGreeterHandler struct{}

UnimplementedGreeterHandler returns CodeUnimplemented from all methods.

func (UnimplementedGreeterHandler) SayHello

func (UnimplementedGreeterHandler) SayHello(context.Context, *connect.Request[examples.HelloRequest]) (*connect.Response[examples.HelloReply], error)