ghostnotifierconnect

Documentation

Index

• Constants
• func NewGhostNotifierApiHandler(svc GhostNotifierApiHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type GhostNotifierApiClient
  • func NewGhostNotifierApiClient(httpClient connect_go.HTTPClient, baseURL string, ...) GhostNotifierApiClient
• type GhostNotifierApiHandler
• type UnimplementedGhostNotifierApiHandler
  • func (UnimplementedGhostNotifierApiHandler) ListNotifications(context.Context, *connect_go.Request[ghostnotifier.ListNotificationsReq], ...) error

Constants

const (
	// GhostNotifierApiListNotificationsProcedure is the fully-qualified name of the GhostNotifierApi's
	// ListNotifications RPC.
	GhostNotifierApiListNotificationsProcedure = "/api.v1alpha1.ghostnotifier.GhostNotifierApi/ListNotifications"
)

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 (
	// GhostNotifierApiName is the fully-qualified name of the GhostNotifierApi service.
	GhostNotifierApiName = "api.v1alpha1.ghostnotifier.GhostNotifierApi"
)

Functions

func NewGhostNotifierApiHandler

func NewGhostNotifierApiHandler(svc GhostNotifierApiHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewGhostNotifierApiHandler 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 GhostNotifierApiClient

type GhostNotifierApiClient interface {
	// Opens a server side stream that will forward and ghost notifications to the client for the given user
	ListNotifications(context.Context, *connect_go.Request[ghostnotifier.ListNotificationsReq]) (*connect_go.ServerStreamForClient[commons.GhostNotification], error)
}

GhostNotifierApiClient is a client for the api.v1alpha1.ghostnotifier.GhostNotifierApi service.

func NewGhostNotifierApiClient

func NewGhostNotifierApiClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) GhostNotifierApiClient

NewGhostNotifierApiClient constructs a client for the api.v1alpha1.ghostnotifier.GhostNotifierApi 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 GhostNotifierApiHandler

type GhostNotifierApiHandler interface {
	// Opens a server side stream that will forward and ghost notifications to the client for the given user
	ListNotifications(context.Context, *connect_go.Request[ghostnotifier.ListNotificationsReq], *connect_go.ServerStream[commons.GhostNotification]) error
}

GhostNotifierApiHandler is an implementation of the api.v1alpha1.ghostnotifier.GhostNotifierApi service.

type UnimplementedGhostNotifierApiHandler

type UnimplementedGhostNotifierApiHandler struct{}

UnimplementedGhostNotifierApiHandler returns CodeUnimplemented from all methods.

func (UnimplementedGhostNotifierApiHandler) ListNotifications

func (UnimplementedGhostNotifierApiHandler) ListNotifications(context.Context, *connect_go.Request[ghostnotifier.ListNotificationsReq], *connect_go.ServerStream[commons.GhostNotification]) error