localv1connect

Documentation

Index

• Constants
• func NewLocalServiceHandler(svc LocalServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type LocalServiceClient
  • func NewLocalServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) LocalServiceClient
• type LocalServiceHandler
• type UnimplementedLocalServiceHandler
  • func (UnimplementedLocalServiceHandler) GetMetadata(context.Context, *connect.Request[v1.GetMetadataRequest]) (*connect.Response[v1.GetMetadataResponse], error)
  • func (UnimplementedLocalServiceHandler) GetVersion(context.Context, *connect.Request[v1.GetVersionRequest]) (*connect.Response[v1.GetVersionResponse], error)
  • func (UnimplementedLocalServiceHandler) Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)

Constants

const (
	// LocalServicePingProcedure is the fully-qualified name of the LocalService's Ping RPC.
	LocalServicePingProcedure = "/rill.local.v1.LocalService/Ping"
	// LocalServiceGetMetadataProcedure is the fully-qualified name of the LocalService's GetMetadata
	// RPC.
	LocalServiceGetMetadataProcedure = "/rill.local.v1.LocalService/GetMetadata"
	// LocalServiceGetVersionProcedure is the fully-qualified name of the LocalService's GetVersion RPC.
	LocalServiceGetVersionProcedure = "/rill.local.v1.LocalService/GetVersion"
)

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 (
	// LocalServiceName is the fully-qualified name of the LocalService service.
	LocalServiceName = "rill.local.v1.LocalService"
)

Functions

func NewLocalServiceHandler

func NewLocalServiceHandler(svc LocalServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewLocalServiceHandler 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 LocalServiceClient

type LocalServiceClient interface {
	// Ping returns the current time.
	Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
	// GetMetadata returns information about the local Rill instance.
	GetMetadata(context.Context, *connect.Request[v1.GetMetadataRequest]) (*connect.Response[v1.GetMetadataResponse], error)
	// GetVersion returns details about the current and latest available Rill versions.
	GetVersion(context.Context, *connect.Request[v1.GetVersionRequest]) (*connect.Response[v1.GetVersionResponse], error)
}

LocalServiceClient is a client for the rill.local.v1.LocalService service.

func NewLocalServiceClient

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

NewLocalServiceClient constructs a client for the rill.local.v1.LocalService 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 LocalServiceHandler

type LocalServiceHandler interface {
	// Ping returns the current time.
	Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
	// GetMetadata returns information about the local Rill instance.
	GetMetadata(context.Context, *connect.Request[v1.GetMetadataRequest]) (*connect.Response[v1.GetMetadataResponse], error)
	// GetVersion returns details about the current and latest available Rill versions.
	GetVersion(context.Context, *connect.Request[v1.GetVersionRequest]) (*connect.Response[v1.GetVersionResponse], error)
}

LocalServiceHandler is an implementation of the rill.local.v1.LocalService service.

type UnimplementedLocalServiceHandler

type UnimplementedLocalServiceHandler struct{}

UnimplementedLocalServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedLocalServiceHandler) GetMetadata

func (UnimplementedLocalServiceHandler) GetMetadata(context.Context, *connect.Request[v1.GetMetadataRequest]) (*connect.Response[v1.GetMetadataResponse], error)

func (UnimplementedLocalServiceHandler) GetVersion

func (UnimplementedLocalServiceHandler) GetVersion(context.Context, *connect.Request[v1.GetVersionRequest]) (*connect.Response[v1.GetVersionResponse], error)

func (UnimplementedLocalServiceHandler) Ping

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