channelzv1connect

Documentation

Index

• Constants
• func NewChannelzHandler(svc ChannelzHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type ChannelzClient
  • func NewChannelzClient(httpClient connect_go.HTTPClient, baseURL string, ...) ChannelzClient
• type ChannelzHandler
• type UnimplementedChannelzHandler
  • func (UnimplementedChannelzHandler) GetChannel(context.Context, *connect_go.Request[v1.GetChannelRequest]) (*connect_go.Response[v1.GetChannelResponse], error)
  • func (UnimplementedChannelzHandler) GetServer(context.Context, *connect_go.Request[v1.GetServerRequest]) (*connect_go.Response[v1.GetServerResponse], error)
  • func (UnimplementedChannelzHandler) GetServerSockets(context.Context, *connect_go.Request[v1.GetServerSocketsRequest]) (*connect_go.Response[v1.GetServerSocketsResponse], error)
  • func (UnimplementedChannelzHandler) GetServers(context.Context, *connect_go.Request[v1.GetServersRequest]) (*connect_go.Response[v1.GetServersResponse], error)
  • func (UnimplementedChannelzHandler) GetSocket(context.Context, *connect_go.Request[v1.GetSocketRequest]) (*connect_go.Response[v1.GetSocketResponse], error)
  • func (UnimplementedChannelzHandler) GetSubchannel(context.Context, *connect_go.Request[v1.GetSubchannelRequest]) (*connect_go.Response[v1.GetSubchannelResponse], error)
  • func (UnimplementedChannelzHandler) GetTopChannels(context.Context, *connect_go.Request[v1.GetTopChannelsRequest]) (*connect_go.Response[v1.GetTopChannelsResponse], error)

Constants

const (
	// ChannelzGetTopChannelsProcedure is the fully-qualified name of the Channelz's GetTopChannels RPC.
	ChannelzGetTopChannelsProcedure = "/grpc.channelz.v1.Channelz/GetTopChannels"
	// ChannelzGetServersProcedure is the fully-qualified name of the Channelz's GetServers RPC.
	ChannelzGetServersProcedure = "/grpc.channelz.v1.Channelz/GetServers"
	// ChannelzGetServerProcedure is the fully-qualified name of the Channelz's GetServer RPC.
	ChannelzGetServerProcedure = "/grpc.channelz.v1.Channelz/GetServer"
	// ChannelzGetServerSocketsProcedure is the fully-qualified name of the Channelz's GetServerSockets
	// RPC.
	ChannelzGetServerSocketsProcedure = "/grpc.channelz.v1.Channelz/GetServerSockets"
	// ChannelzGetChannelProcedure is the fully-qualified name of the Channelz's GetChannel RPC.
	ChannelzGetChannelProcedure = "/grpc.channelz.v1.Channelz/GetChannel"
	// ChannelzGetSubchannelProcedure is the fully-qualified name of the Channelz's GetSubchannel RPC.
	ChannelzGetSubchannelProcedure = "/grpc.channelz.v1.Channelz/GetSubchannel"
	// ChannelzGetSocketProcedure is the fully-qualified name of the Channelz's GetSocket RPC.
	ChannelzGetSocketProcedure = "/grpc.channelz.v1.Channelz/GetSocket"
)

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 (
	// ChannelzName is the fully-qualified name of the Channelz service.
	ChannelzName = "grpc.channelz.v1.Channelz"
)

Functions

func NewChannelzHandler

func NewChannelzHandler(svc ChannelzHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewChannelzHandler 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 ChannelzClient

type ChannelzClient interface {
	// Gets all root channels (i.e. channels the application has directly
	// created). This does not include subchannels nor non-top level channels.
	GetTopChannels(context.Context, *connect_go.Request[v1.GetTopChannelsRequest]) (*connect_go.Response[v1.GetTopChannelsResponse], error)
	// Gets all servers that exist in the process.
	GetServers(context.Context, *connect_go.Request[v1.GetServersRequest]) (*connect_go.Response[v1.GetServersResponse], error)
	// Returns a single Server, or else a NOT_FOUND code.
	GetServer(context.Context, *connect_go.Request[v1.GetServerRequest]) (*connect_go.Response[v1.GetServerResponse], error)
	// Gets all server sockets that exist in the process.
	GetServerSockets(context.Context, *connect_go.Request[v1.GetServerSocketsRequest]) (*connect_go.Response[v1.GetServerSocketsResponse], error)
	// Returns a single Channel, or else a NOT_FOUND code.
	GetChannel(context.Context, *connect_go.Request[v1.GetChannelRequest]) (*connect_go.Response[v1.GetChannelResponse], error)
	// Returns a single Subchannel, or else a NOT_FOUND code.
	GetSubchannel(context.Context, *connect_go.Request[v1.GetSubchannelRequest]) (*connect_go.Response[v1.GetSubchannelResponse], error)
	// Returns a single Socket or else a NOT_FOUND code.
	GetSocket(context.Context, *connect_go.Request[v1.GetSocketRequest]) (*connect_go.Response[v1.GetSocketResponse], error)
}

ChannelzClient is a client for the grpc.channelz.v1.Channelz service.

func NewChannelzClient

func NewChannelzClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) ChannelzClient

NewChannelzClient constructs a client for the grpc.channelz.v1.Channelz 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 ChannelzHandler

type ChannelzHandler interface {
	// Gets all root channels (i.e. channels the application has directly
	// created). This does not include subchannels nor non-top level channels.
	GetTopChannels(context.Context, *connect_go.Request[v1.GetTopChannelsRequest]) (*connect_go.Response[v1.GetTopChannelsResponse], error)
	// Gets all servers that exist in the process.
	GetServers(context.Context, *connect_go.Request[v1.GetServersRequest]) (*connect_go.Response[v1.GetServersResponse], error)
	// Returns a single Server, or else a NOT_FOUND code.
	GetServer(context.Context, *connect_go.Request[v1.GetServerRequest]) (*connect_go.Response[v1.GetServerResponse], error)
	// Gets all server sockets that exist in the process.
	GetServerSockets(context.Context, *connect_go.Request[v1.GetServerSocketsRequest]) (*connect_go.Response[v1.GetServerSocketsResponse], error)
	// Returns a single Channel, or else a NOT_FOUND code.
	GetChannel(context.Context, *connect_go.Request[v1.GetChannelRequest]) (*connect_go.Response[v1.GetChannelResponse], error)
	// Returns a single Subchannel, or else a NOT_FOUND code.
	GetSubchannel(context.Context, *connect_go.Request[v1.GetSubchannelRequest]) (*connect_go.Response[v1.GetSubchannelResponse], error)
	// Returns a single Socket or else a NOT_FOUND code.
	GetSocket(context.Context, *connect_go.Request[v1.GetSocketRequest]) (*connect_go.Response[v1.GetSocketResponse], error)
}

ChannelzHandler is an implementation of the grpc.channelz.v1.Channelz service.

type UnimplementedChannelzHandler

type UnimplementedChannelzHandler struct{}

UnimplementedChannelzHandler returns CodeUnimplemented from all methods.

func (UnimplementedChannelzHandler) GetChannel

func (UnimplementedChannelzHandler) GetChannel(context.Context, *connect_go.Request[v1.GetChannelRequest]) (*connect_go.Response[v1.GetChannelResponse], error)

func (UnimplementedChannelzHandler) GetServer

func (UnimplementedChannelzHandler) GetServer(context.Context, *connect_go.Request[v1.GetServerRequest]) (*connect_go.Response[v1.GetServerResponse], error)

func (UnimplementedChannelzHandler) GetServerSockets

func (UnimplementedChannelzHandler) GetServerSockets(context.Context, *connect_go.Request[v1.GetServerSocketsRequest]) (*connect_go.Response[v1.GetServerSocketsResponse], error)

func (UnimplementedChannelzHandler) GetServers

func (UnimplementedChannelzHandler) GetServers(context.Context, *connect_go.Request[v1.GetServersRequest]) (*connect_go.Response[v1.GetServersResponse], error)

func (UnimplementedChannelzHandler) GetSocket

func (UnimplementedChannelzHandler) GetSocket(context.Context, *connect_go.Request[v1.GetSocketRequest]) (*connect_go.Response[v1.GetSocketResponse], error)

func (UnimplementedChannelzHandler) GetSubchannel

func (UnimplementedChannelzHandler) GetSubchannel(context.Context, *connect_go.Request[v1.GetSubchannelRequest]) (*connect_go.Response[v1.GetSubchannelResponse], error)

func (UnimplementedChannelzHandler) GetTopChannels

func (UnimplementedChannelzHandler) GetTopChannels(context.Context, *connect_go.Request[v1.GetTopChannelsRequest]) (*connect_go.Response[v1.GetTopChannelsResponse], error)