arkv1connect

Documentation

Index

• Constants
• func NewArkApiHandler(svc ArkApiHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type ArkApiClient
  • func NewArkApiClient(httpClient connect_go.HTTPClient, baseURL string, ...) ArkApiClient
• type ArkApiHandler
• type UnimplementedArkApiHandler
  • func (UnimplementedArkApiHandler) UploadFile(context.Context, *connect_go.ClientStream[v1.UploadFileRequest]) (*connect_go.Response[v1.UploadFileResponse], error)

Constants

const (
	// ArkApiName is the fully-qualified name of the ArkApi service.
	ArkApiName = "ark.v1.ArkApi"
)

const (
	// ArkApiUploadFileProcedure is the fully-qualified name of the ArkApi's UploadFile RPC.
	ArkApiUploadFileProcedure = "/ark.v1.ArkApi/UploadFile"
)

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 NewArkApiHandler

func NewArkApiHandler(svc ArkApiHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewArkApiHandler 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 ArkApiClient

type ArkApiClient interface {
	UploadFile(context.Context) *connect_go.ClientStreamForClient[v1.UploadFileRequest, v1.UploadFileResponse]
}

ArkApiClient is a client for the ark.v1.ArkApi service.

func NewArkApiClient

func NewArkApiClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) ArkApiClient

NewArkApiClient constructs a client for the ark.v1.ArkApi 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 ArkApiHandler

type ArkApiHandler interface {
	UploadFile(context.Context, *connect_go.ClientStream[v1.UploadFileRequest]) (*connect_go.Response[v1.UploadFileResponse], error)
}

ArkApiHandler is an implementation of the ark.v1.ArkApi service.

type UnimplementedArkApiHandler

type UnimplementedArkApiHandler struct{}

UnimplementedArkApiHandler returns CodeUnimplemented from all methods.

func (UnimplementedArkApiHandler) UploadFile

func (UnimplementedArkApiHandler) UploadFile(context.Context, *connect_go.ClientStream[v1.UploadFileRequest]) (*connect_go.Response[v1.UploadFileResponse], error)