srecconnect

Documentation

Index

• Constants
• func NewSrecHandler(svc SrecHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type SrecClient
  • func NewSrecClient(httpClient connect_go.HTTPClient, baseURL string, ...) SrecClient
• type SrecHandler
• type UnimplementedSrecHandler
  • func (UnimplementedSrecHandler) DeleteScreenRecording(context.Context, *connect_go.Request[srec.DeleteScreenRecordingRequest]) (*connect_go.Response[srec.DeleteScreenRecordingResponse], error)
  • func (UnimplementedSrecHandler) GetScreenRecordingURL(context.Context, *connect_go.Request[srec.GetScreenRecordingURLRequest]) (*connect_go.Response[srec.GetScreenRecordingURLResponse], error)
  • func (UnimplementedSrecHandler) ListScreenRecordings(context.Context, *connect_go.Request[srec.ListScreenRecordingsRequest]) (*connect_go.Response[srec.ListScreenRecordingsResponse], error)

Constants

const (
	// SrecListScreenRecordingsProcedure is the fully-qualified name of the Srec's ListScreenRecordings
	// RPC.
	SrecListScreenRecordingsProcedure = "/api.v1alpha1.srec.Srec/ListScreenRecordings"
	// SrecGetScreenRecordingURLProcedure is the fully-qualified name of the Srec's
	// GetScreenRecordingURL RPC.
	SrecGetScreenRecordingURLProcedure = "/api.v1alpha1.srec.Srec/GetScreenRecordingURL"
	// SrecDeleteScreenRecordingProcedure is the fully-qualified name of the Srec's
	// DeleteScreenRecording RPC.
	SrecDeleteScreenRecordingProcedure = "/api.v1alpha1.srec.Srec/DeleteScreenRecording"
)

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 (
	// SrecName is the fully-qualified name of the Srec service.
	SrecName = "api.v1alpha1.srec.Srec"
)

Functions

func NewSrecHandler

func NewSrecHandler(svc SrecHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewSrecHandler 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 SrecClient

type SrecClient interface {
	// ListScreenRecordings returns screen recordings.
	ListScreenRecordings(context.Context, *connect_go.Request[srec.ListScreenRecordingsRequest]) (*connect_go.Response[srec.ListScreenRecordingsResponse], error)
	// GetScreenRecordingURL returns the screen recording url.
	GetScreenRecordingURL(context.Context, *connect_go.Request[srec.GetScreenRecordingURLRequest]) (*connect_go.Response[srec.GetScreenRecordingURLResponse], error)
	// DeleteScreenRecording deletes a screen recording.
	DeleteScreenRecording(context.Context, *connect_go.Request[srec.DeleteScreenRecordingRequest]) (*connect_go.Response[srec.DeleteScreenRecordingResponse], error)
}

SrecClient is a client for the api.v1alpha1.srec.Srec service.

func NewSrecClient

func NewSrecClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) SrecClient

NewSrecClient constructs a client for the api.v1alpha1.srec.Srec 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 SrecHandler

type SrecHandler interface {
	// ListScreenRecordings returns screen recordings.
	ListScreenRecordings(context.Context, *connect_go.Request[srec.ListScreenRecordingsRequest]) (*connect_go.Response[srec.ListScreenRecordingsResponse], error)
	// GetScreenRecordingURL returns the screen recording url.
	GetScreenRecordingURL(context.Context, *connect_go.Request[srec.GetScreenRecordingURLRequest]) (*connect_go.Response[srec.GetScreenRecordingURLResponse], error)
	// DeleteScreenRecording deletes a screen recording.
	DeleteScreenRecording(context.Context, *connect_go.Request[srec.DeleteScreenRecordingRequest]) (*connect_go.Response[srec.DeleteScreenRecordingResponse], error)
}

SrecHandler is an implementation of the api.v1alpha1.srec.Srec service.

type UnimplementedSrecHandler

type UnimplementedSrecHandler struct{}

UnimplementedSrecHandler returns CodeUnimplemented from all methods.

func (UnimplementedSrecHandler) DeleteScreenRecording

func (UnimplementedSrecHandler) DeleteScreenRecording(context.Context, *connect_go.Request[srec.DeleteScreenRecordingRequest]) (*connect_go.Response[srec.DeleteScreenRecordingResponse], error)

func (UnimplementedSrecHandler) GetScreenRecordingURL

func (UnimplementedSrecHandler) GetScreenRecordingURL(context.Context, *connect_go.Request[srec.GetScreenRecordingURLRequest]) (*connect_go.Response[srec.GetScreenRecordingURLResponse], error)

func (UnimplementedSrecHandler) ListScreenRecordings

func (UnimplementedSrecHandler) ListScreenRecordings(context.Context, *connect_go.Request[srec.ListScreenRecordingsRequest]) (*connect_go.Response[srec.ListScreenRecordingsResponse], error)