Documentation
¶
Index ¶
- Constants
- func NewApiServiceHandler(svc ApiServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type ApiServiceClient
- type ApiServiceHandler
- type UnimplementedApiServiceHandler
- func (UnimplementedApiServiceHandler) CheckoutGetLink(context.Context, *connect.Request[v1.CheckoutGetLinkRequest]) (*connect.Response[v1.CheckoutGetLinkResponse], error)
- func (UnimplementedApiServiceHandler) DeviceHandshake(context.Context, *connect.Request[v1.DeviceHandshakeRequest]) (*connect.Response[v1.DeviceHandshakeResponse], error)
Constants ¶
const ( // ApiServiceDeviceHandshakeProcedure is the fully-qualified name of the ApiService's // DeviceHandshake RPC. ApiServiceDeviceHandshakeProcedure = "/api.v1.ApiService/DeviceHandshake" // ApiServiceCheckoutGetLinkProcedure is the fully-qualified name of the ApiService's // CheckoutGetLink RPC. ApiServiceCheckoutGetLinkProcedure = "/api.v1.ApiService/CheckoutGetLink" )
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 (
// ApiServiceName is the fully-qualified name of the ApiService service.
ApiServiceName = "api.v1.ApiService"
)
Variables ¶
This section is empty.
Functions ¶
func NewApiServiceHandler ¶
func NewApiServiceHandler(svc ApiServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewApiServiceHandler 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 ApiServiceClient ¶
type ApiServiceClient interface {
// ---------------------------------------------------------
// IDENTITY MANAGEMENT
// ---------------------------------------------------------
// Exchanges a Hardware Fingerprint for a PASETO Session Token.
// Note: Request requires HMAC Headers (X-Signature, X-Timestamp, X-Nonce).
DeviceHandshake(context.Context, *connect.Request[v1.DeviceHandshakeRequest]) (*connect.Response[v1.DeviceHandshakeResponse], error)
// ---------------------------------------------------------
// Checkout & Subscription Management
// ---------------------------------------------------------
CheckoutGetLink(context.Context, *connect.Request[v1.CheckoutGetLinkRequest]) (*connect.Response[v1.CheckoutGetLinkResponse], error)
}
ApiServiceClient is a client for the api.v1.ApiService service.
func NewApiServiceClient ¶
func NewApiServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ApiServiceClient
NewApiServiceClient constructs a client for the api.v1.ApiService 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 ApiServiceHandler ¶
type ApiServiceHandler interface {
// ---------------------------------------------------------
// IDENTITY MANAGEMENT
// ---------------------------------------------------------
// Exchanges a Hardware Fingerprint for a PASETO Session Token.
// Note: Request requires HMAC Headers (X-Signature, X-Timestamp, X-Nonce).
DeviceHandshake(context.Context, *connect.Request[v1.DeviceHandshakeRequest]) (*connect.Response[v1.DeviceHandshakeResponse], error)
// ---------------------------------------------------------
// Checkout & Subscription Management
// ---------------------------------------------------------
CheckoutGetLink(context.Context, *connect.Request[v1.CheckoutGetLinkRequest]) (*connect.Response[v1.CheckoutGetLinkResponse], error)
}
ApiServiceHandler is an implementation of the api.v1.ApiService service.
type UnimplementedApiServiceHandler ¶
type UnimplementedApiServiceHandler struct{}
UnimplementedApiServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedApiServiceHandler) CheckoutGetLink ¶
func (UnimplementedApiServiceHandler) CheckoutGetLink(context.Context, *connect.Request[v1.CheckoutGetLinkRequest]) (*connect.Response[v1.CheckoutGetLinkResponse], error)
func (UnimplementedApiServiceHandler) DeviceHandshake ¶
func (UnimplementedApiServiceHandler) DeviceHandshake(context.Context, *connect.Request[v1.DeviceHandshakeRequest]) (*connect.Response[v1.DeviceHandshakeResponse], error)
Source Files