Documentation
¶
Index ¶
Constants ¶
const ( // DashboardServiceStreamConsoleProcedure is the fully-qualified name of the DashboardService's // StreamConsole RPC. DashboardServiceStreamConsoleProcedure = "/gopherstack.dashboard.v1.DashboardService/StreamConsole" // DashboardServiceStreamMetricsProcedure is the fully-qualified name of the DashboardService's // StreamMetrics RPC. DashboardServiceStreamMetricsProcedure = "/gopherstack.dashboard.v1.DashboardService/StreamMetrics" )
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 (
// DashboardServiceName is the fully-qualified name of the DashboardService service.
DashboardServiceName = "gopherstack.dashboard.v1.DashboardService"
)
Variables ¶
This section is empty.
Functions ¶
func NewDashboardServiceHandler ¶
func NewDashboardServiceHandler(svc DashboardServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewDashboardServiceHandler 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 DashboardServiceClient ¶
type DashboardServiceClient interface {
StreamConsole(
context.Context,
*connect.Request[v1.StreamConsoleRequest],
) (*connect.ServerStreamForClient[v1.StreamConsoleResponse], error)
StreamMetrics(
context.Context,
*connect.Request[v1.StreamMetricsRequest],
) (*connect.ServerStreamForClient[v1.StreamMetricsResponse], error)
}
DashboardServiceClient is a client for the gopherstack.dashboard.v1.DashboardService service.
func NewDashboardServiceClient ¶
func NewDashboardServiceClient( httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption, ) DashboardServiceClient
NewDashboardServiceClient constructs a client for the gopherstack.dashboard.v1.DashboardService 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 DashboardServiceHandler ¶
type DashboardServiceHandler interface {
StreamConsole(
context.Context,
*connect.Request[v1.StreamConsoleRequest],
*connect.ServerStream[v1.StreamConsoleResponse],
) error
StreamMetrics(
context.Context,
*connect.Request[v1.StreamMetricsRequest],
*connect.ServerStream[v1.StreamMetricsResponse],
) error
}
DashboardServiceHandler is an implementation of the gopherstack.dashboard.v1.DashboardService service.
type UnimplementedDashboardServiceHandler ¶
type UnimplementedDashboardServiceHandler struct{}
UnimplementedDashboardServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedDashboardServiceHandler) StreamConsole ¶
func (UnimplementedDashboardServiceHandler) StreamConsole( context.Context, *connect.Request[v1.StreamConsoleRequest], *connect.ServerStream[v1.StreamConsoleResponse], ) error
func (UnimplementedDashboardServiceHandler) StreamMetrics ¶
func (UnimplementedDashboardServiceHandler) StreamMetrics( context.Context, *connect.Request[v1.StreamMetricsRequest], *connect.ServerStream[v1.StreamMetricsResponse], ) error
Source Files