notificationsv1connect

Documentation

Index

• Constants
• func NewNotificationsHandler(svc NotificationsHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type NotificationsClient
  • func NewNotificationsClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) NotificationsClient
• type NotificationsHandler
• type UnimplementedNotificationsHandler
  • func (UnimplementedNotificationsHandler) DeleteInstallation(context.Context, *connect.Request[v1.DeleteInstallationRequest]) (*connect.Response[emptypb.Empty], error)
  • func (UnimplementedNotificationsHandler) RegisterInstallation(context.Context, *connect.Request[v1.RegisterInstallationRequest]) (*connect.Response[v1.RegisterInstallationResponse], error)
  • func (UnimplementedNotificationsHandler) Subscribe(context.Context, *connect.Request[v1.SubscribeRequest]) (*connect.Response[emptypb.Empty], error)
  • func (UnimplementedNotificationsHandler) SubscribeWithMetadata(context.Context, *connect.Request[v1.SubscribeWithMetadataRequest]) (*connect.Response[emptypb.Empty], error)
  • func (UnimplementedNotificationsHandler) Unsubscribe(context.Context, *connect.Request[v1.UnsubscribeRequest]) (*connect.Response[emptypb.Empty], error)

Constants

const (
	// NotificationsRegisterInstallationProcedure is the fully-qualified name of the Notifications's
	// RegisterInstallation RPC.
	NotificationsRegisterInstallationProcedure = "/notifications.v1.Notifications/RegisterInstallation"
	// NotificationsDeleteInstallationProcedure is the fully-qualified name of the Notifications's
	// DeleteInstallation RPC.
	NotificationsDeleteInstallationProcedure = "/notifications.v1.Notifications/DeleteInstallation"
	// NotificationsSubscribeProcedure is the fully-qualified name of the Notifications's Subscribe RPC.
	NotificationsSubscribeProcedure = "/notifications.v1.Notifications/Subscribe"
	// NotificationsSubscribeWithMetadataProcedure is the fully-qualified name of the Notifications's
	// SubscribeWithMetadata RPC.
	NotificationsSubscribeWithMetadataProcedure = "/notifications.v1.Notifications/SubscribeWithMetadata"
	// NotificationsUnsubscribeProcedure is the fully-qualified name of the Notifications's Unsubscribe
	// RPC.
	NotificationsUnsubscribeProcedure = "/notifications.v1.Notifications/Unsubscribe"
)

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 (
	// NotificationsName is the fully-qualified name of the Notifications service.
	NotificationsName = "notifications.v1.Notifications"
)

Functions

func NewNotificationsHandler

func NewNotificationsHandler(svc NotificationsHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewNotificationsHandler 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 NotificationsClient

type NotificationsClient interface {
	RegisterInstallation(context.Context, *connect.Request[v1.RegisterInstallationRequest]) (*connect.Response[v1.RegisterInstallationResponse], error)
	DeleteInstallation(context.Context, *connect.Request[v1.DeleteInstallationRequest]) (*connect.Response[emptypb.Empty], error)
	Subscribe(context.Context, *connect.Request[v1.SubscribeRequest]) (*connect.Response[emptypb.Empty], error)
	SubscribeWithMetadata(context.Context, *connect.Request[v1.SubscribeWithMetadataRequest]) (*connect.Response[emptypb.Empty], error)
	Unsubscribe(context.Context, *connect.Request[v1.UnsubscribeRequest]) (*connect.Response[emptypb.Empty], error)
}

NotificationsClient is a client for the notifications.v1.Notifications service.

func NewNotificationsClient

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

NewNotificationsClient constructs a client for the notifications.v1.Notifications 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 NotificationsHandler

type NotificationsHandler interface {
	RegisterInstallation(context.Context, *connect.Request[v1.RegisterInstallationRequest]) (*connect.Response[v1.RegisterInstallationResponse], error)
	DeleteInstallation(context.Context, *connect.Request[v1.DeleteInstallationRequest]) (*connect.Response[emptypb.Empty], error)
	Subscribe(context.Context, *connect.Request[v1.SubscribeRequest]) (*connect.Response[emptypb.Empty], error)
	SubscribeWithMetadata(context.Context, *connect.Request[v1.SubscribeWithMetadataRequest]) (*connect.Response[emptypb.Empty], error)
	Unsubscribe(context.Context, *connect.Request[v1.UnsubscribeRequest]) (*connect.Response[emptypb.Empty], error)
}

NotificationsHandler is an implementation of the notifications.v1.Notifications service.

type UnimplementedNotificationsHandler

type UnimplementedNotificationsHandler struct{}

UnimplementedNotificationsHandler returns CodeUnimplemented from all methods.

func (UnimplementedNotificationsHandler) DeleteInstallation

func (UnimplementedNotificationsHandler) DeleteInstallation(context.Context, *connect.Request[v1.DeleteInstallationRequest]) (*connect.Response[emptypb.Empty], error)

func (UnimplementedNotificationsHandler) RegisterInstallation

func (UnimplementedNotificationsHandler) RegisterInstallation(context.Context, *connect.Request[v1.RegisterInstallationRequest]) (*connect.Response[v1.RegisterInstallationResponse], error)

func (UnimplementedNotificationsHandler) Subscribe

func (UnimplementedNotificationsHandler) Subscribe(context.Context, *connect.Request[v1.SubscribeRequest]) (*connect.Response[emptypb.Empty], error)

func (UnimplementedNotificationsHandler) SubscribeWithMetadata

func (UnimplementedNotificationsHandler) SubscribeWithMetadata(context.Context, *connect.Request[v1.SubscribeWithMetadataRequest]) (*connect.Response[emptypb.Empty], error)

func (UnimplementedNotificationsHandler) Unsubscribe

func (UnimplementedNotificationsHandler) Unsubscribe(context.Context, *connect.Request[v1.UnsubscribeRequest]) (*connect.Response[emptypb.Empty], error)