Documentation
¶
Index ¶
- Constants
- func NewAgentAPIHandler(svc AgentAPIHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type AgentAPIClient
- type AgentAPIHandler
- type UnimplementedAgentAPIHandler
- func (UnimplementedAgentAPIHandler) ListNftables(context.Context, *connect.Request[v1.NftablesReq_List]) (*connect.Response[v1.NftablesResp_List], error)
- func (UnimplementedAgentAPIHandler) ListSocketStatistics(context.Context, *connect.Request[v1.SocketStatReq_List]) (*connect.Response[v1.SocketStatResp_List], error)
- func (UnimplementedAgentAPIHandler) WatchNftables(context.Context, *connect.Request[v1.NftablesReq_Watch], ...) error
- func (UnimplementedAgentAPIHandler) WatchSocketStatistics(context.Context, *connect.Request[v1.SocketStatReq_Watch], ...) error
Constants ¶
const ( // AgentAPIListSocketStatisticsProcedure is the fully-qualified name of the AgentAPI's // ListSocketStatistics RPC. AgentAPIListSocketStatisticsProcedure = "/agent.v1.AgentAPI/ListSocketStatistics" // AgentAPIWatchSocketStatisticsProcedure is the fully-qualified name of the AgentAPI's // WatchSocketStatistics RPC. AgentAPIWatchSocketStatisticsProcedure = "/agent.v1.AgentAPI/WatchSocketStatistics" // AgentAPIListNftablesProcedure is the fully-qualified name of the AgentAPI's ListNftables RPC. AgentAPIListNftablesProcedure = "/agent.v1.AgentAPI/ListNftables" // AgentAPIWatchNftablesProcedure is the fully-qualified name of the AgentAPI's WatchNftables RPC. AgentAPIWatchNftablesProcedure = "/agent.v1.AgentAPI/WatchNftables" )
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 (
// AgentAPIName is the fully-qualified name of the AgentAPI service.
AgentAPIName = "agent.v1.AgentAPI"
)
Variables ¶
This section is empty.
Functions ¶
func NewAgentAPIHandler ¶
func NewAgentAPIHandler(svc AgentAPIHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewAgentAPIHandler 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 AgentAPIClient ¶
type AgentAPIClient interface {
// ListSocketStatistics: list socket statistics
ListSocketStatistics(context.Context, *connect.Request[v1.SocketStatReq_List]) (*connect.Response[v1.SocketStatResp_List], error)
// WatchSocketStatistics: watch socket statistics
WatchSocketStatistics(context.Context, *connect.Request[v1.SocketStatReq_Watch]) (*connect.ServerStreamForClient[v1.SocketStatResp_Watch], error)
// ListNftables: list nftables information
ListNftables(context.Context, *connect.Request[v1.NftablesReq_List]) (*connect.Response[v1.NftablesResp_List], error)
// WatchNftables: watch nftables information
WatchNftables(context.Context, *connect.Request[v1.NftablesReq_Watch]) (*connect.ServerStreamForClient[v1.NftablesResp_Watch], error)
}
AgentAPIClient is a client for the agent.v1.AgentAPI service.
func NewAgentAPIClient ¶
func NewAgentAPIClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) AgentAPIClient
NewAgentAPIClient constructs a client for the agent.v1.AgentAPI 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 AgentAPIHandler ¶
type AgentAPIHandler interface {
// ListSocketStatistics: list socket statistics
ListSocketStatistics(context.Context, *connect.Request[v1.SocketStatReq_List]) (*connect.Response[v1.SocketStatResp_List], error)
// WatchSocketStatistics: watch socket statistics
WatchSocketStatistics(context.Context, *connect.Request[v1.SocketStatReq_Watch], *connect.ServerStream[v1.SocketStatResp_Watch]) error
// ListNftables: list nftables information
ListNftables(context.Context, *connect.Request[v1.NftablesReq_List]) (*connect.Response[v1.NftablesResp_List], error)
// WatchNftables: watch nftables information
WatchNftables(context.Context, *connect.Request[v1.NftablesReq_Watch], *connect.ServerStream[v1.NftablesResp_Watch]) error
}
AgentAPIHandler is an implementation of the agent.v1.AgentAPI service.
type UnimplementedAgentAPIHandler ¶
type UnimplementedAgentAPIHandler struct{}
UnimplementedAgentAPIHandler returns CodeUnimplemented from all methods.
func (UnimplementedAgentAPIHandler) ListNftables ¶
func (UnimplementedAgentAPIHandler) ListNftables(context.Context, *connect.Request[v1.NftablesReq_List]) (*connect.Response[v1.NftablesResp_List], error)
func (UnimplementedAgentAPIHandler) ListSocketStatistics ¶
func (UnimplementedAgentAPIHandler) ListSocketStatistics(context.Context, *connect.Request[v1.SocketStatReq_List]) (*connect.Response[v1.SocketStatResp_List], error)
func (UnimplementedAgentAPIHandler) WatchNftables ¶
func (UnimplementedAgentAPIHandler) WatchNftables(context.Context, *connect.Request[v1.NftablesReq_Watch], *connect.ServerStream[v1.NftablesResp_Watch]) error
func (UnimplementedAgentAPIHandler) WatchSocketStatistics ¶
func (UnimplementedAgentAPIHandler) WatchSocketStatistics(context.Context, *connect.Request[v1.SocketStatReq_Watch], *connect.ServerStream[v1.SocketStatResp_Watch]) error