Documentation
¶
Index ¶
- Constants
- func NewSyncServiceHandler(svc SyncServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type SyncServiceClient
- type SyncServiceHandler
- type UnimplementedSyncServiceHandler
- func (UnimplementedSyncServiceHandler) ListDevices(context.Context, *connect.Request[v1.ListDevicesRequest]) (*connect.Response[v1.ListDevicesResponse], error)
- func (UnimplementedSyncServiceHandler) ReportStatus(context.Context, *connect.Request[v1.ReportStatusRequest]) (*connect.Response[v1.ReportStatusResponse], error)
- func (UnimplementedSyncServiceHandler) Watch(context.Context, *connect.Request[v1.WatchRequest], ...) error
Constants ¶
const ( // SyncServiceWatchProcedure is the fully-qualified name of the SyncService's Watch RPC. SyncServiceWatchProcedure = "/devopus.sync.v1.SyncService/Watch" // SyncServiceReportStatusProcedure is the fully-qualified name of the SyncService's ReportStatus // RPC. SyncServiceReportStatusProcedure = "/devopus.sync.v1.SyncService/ReportStatus" // SyncServiceListDevicesProcedure is the fully-qualified name of the SyncService's ListDevices RPC. SyncServiceListDevicesProcedure = "/devopus.sync.v1.SyncService/ListDevices" )
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 (
// SyncServiceName is the fully-qualified name of the SyncService service.
SyncServiceName = "devopus.sync.v1.SyncService"
)
Variables ¶
This section is empty.
Functions ¶
func NewSyncServiceHandler ¶
func NewSyncServiceHandler(svc SyncServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewSyncServiceHandler 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 SyncServiceClient ¶
type SyncServiceClient interface {
// Watch is the agent's connection: the device's desired state now, then again on
// every change. The server closes it when the access token expires; the agent
// reconnects with a fresh one. A member removed from the workspace is cut off.
Watch(context.Context, *connect.Request[v1.WatchRequest]) (*connect.ServerStreamForClient[v1.WatchResponse], error)
// ReportStatus tells the server what the device runs: every environment, features
// created on the device included, and the version of the settings it applied.
ReportStatus(context.Context, *connect.Request[v1.ReportStatusRequest]) (*connect.Response[v1.ReportStatusResponse], error)
// ListDevices shows devices and what they run: the owner and maintainers see all,
// a developer their own.
ListDevices(context.Context, *connect.Request[v1.ListDevicesRequest]) (*connect.Response[v1.ListDevicesResponse], error)
}
SyncServiceClient is a client for the devopus.sync.v1.SyncService service.
func NewSyncServiceClient ¶
func NewSyncServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) SyncServiceClient
NewSyncServiceClient constructs a client for the devopus.sync.v1.SyncService 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 SyncServiceHandler ¶
type SyncServiceHandler interface {
// Watch is the agent's connection: the device's desired state now, then again on
// every change. The server closes it when the access token expires; the agent
// reconnects with a fresh one. A member removed from the workspace is cut off.
Watch(context.Context, *connect.Request[v1.WatchRequest], *connect.ServerStream[v1.WatchResponse]) error
// ReportStatus tells the server what the device runs: every environment, features
// created on the device included, and the version of the settings it applied.
ReportStatus(context.Context, *connect.Request[v1.ReportStatusRequest]) (*connect.Response[v1.ReportStatusResponse], error)
// ListDevices shows devices and what they run: the owner and maintainers see all,
// a developer their own.
ListDevices(context.Context, *connect.Request[v1.ListDevicesRequest]) (*connect.Response[v1.ListDevicesResponse], error)
}
SyncServiceHandler is an implementation of the devopus.sync.v1.SyncService service.
type UnimplementedSyncServiceHandler ¶
type UnimplementedSyncServiceHandler struct{}
UnimplementedSyncServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedSyncServiceHandler) ListDevices ¶
func (UnimplementedSyncServiceHandler) ListDevices(context.Context, *connect.Request[v1.ListDevicesRequest]) (*connect.Response[v1.ListDevicesResponse], error)
func (UnimplementedSyncServiceHandler) ReportStatus ¶
func (UnimplementedSyncServiceHandler) ReportStatus(context.Context, *connect.Request[v1.ReportStatusRequest]) (*connect.Response[v1.ReportStatusResponse], error)
func (UnimplementedSyncServiceHandler) Watch ¶
func (UnimplementedSyncServiceHandler) Watch(context.Context, *connect.Request[v1.WatchRequest], *connect.ServerStream[v1.WatchResponse]) error
Source Files