framework.rpc.grpc_channelz.ChannelzServiceClient Class Reference

Inheritance diagram for framework.rpc.grpc_channelz.ChannelzServiceClient:

Public Member Functions
def	__init__ (self, grpc.Channel channel)
Iterator[Channel]	find_channels_for_target (self, str target, **kwargs)
Optional[Server]	find_server_listening_on_port (self, int port, **kwargs)
Socket	get_socket (self, socket_id, **kwargs)
Subchannel	get_subchannel (self, subchannel_id, **kwargs)
Iterator[Socket]	list_channel_sockets (self, Channel channel, **kwargs)
Iterator[Subchannel]	list_channel_subchannels (self, Channel channel, **kwargs)
Iterator[Channel]	list_channels (self, **kwargs)
Iterator[Socket]	list_server_sockets (self, Server server, **kwargs)
Iterator[Server]	list_servers (self, **kwargs)
Iterator[Socket]	list_subchannels_sockets (self, Subchannel subchannel, **kwargs)
def	sock_address_to_str (cls, Address address)
def	sock_addresses_pretty (cls, Socket socket)
Public Member Functions inherited from framework.rpc.grpc.GrpcClientHelper
def	__init__ (self, grpc.Channel channel, Any stub_class)
Message	call_unary_with_deadline (self, *str rpc, Message req, Optional[int] deadline_sec=DEFAULT_RPC_DEADLINE_SEC, Optional[int] log_level=logging.DEBUG)

Static Public Member Functions
Socket	find_server_socket_matching_client (Iterator[Socket] server_sockets, Socket client_socket)
def	is_ipv4 (Address.TcpIpAddress tcpip_address)
def	is_sock_tcpip_address (Address address)

Additional Inherited Members
Public Attributes inherited from framework.rpc.grpc.GrpcClientHelper
	channel
	log_service_name
	stub
Static Public Attributes inherited from framework.rpc.grpc.GrpcClientHelper
int	DEFAULT_RPC_DEADLINE_SEC = 90

Detailed Description

Definition at line 57 of file grpc_channelz.py.

Constructor & Destructor Documentation

__init__()

def framework.rpc.grpc_channelz.ChannelzServiceClient.__init__	(		self,
		grpc.Channel	channel
	)

Definition at line 60 of file grpc_channelz.py.

Member Function Documentation

find_channels_for_target()

Iterator[Channel] framework.rpc.grpc_channelz.ChannelzServiceClient.find_channels_for_target	(		self,
		str	target,
		**	kwargs
	)

Definition at line 98 of file grpc_channelz.py.

find_server_listening_on_port()

Optional[Server] framework.rpc.grpc_channelz.ChannelzServiceClient.find_server_listening_on_port	(		self,
		int	port,
		**	kwargs
	)

Definition at line 103 of file grpc_channelz.py.

find_server_socket_matching_client()

Socket framework.rpc.grpc_channelz.ChannelzServiceClient.find_server_socket_matching_client ( Iterator[Socket]  server_sockets, Socket  client_socket  )

static

Definition at line 91 of file grpc_channelz.py.

get_socket()

Socket framework.rpc.grpc_channelz.ChannelzServiceClient.get_socket	(		self,
			socket_id,
		**	kwargs
	)

Return a single Socket, otherwise raises RpcError.

Definition at line 201 of file grpc_channelz.py.

get_subchannel()

Subchannel framework.rpc.grpc_channelz.ChannelzServiceClient.get_subchannel	(		self,
			subchannel_id,
		**	kwargs
	)

Return a single Subchannel, otherwise raises RpcError.

Definition at line 193 of file grpc_channelz.py.

is_ipv4()

def framework.rpc.grpc_channelz.ChannelzServiceClient.is_ipv4 ( Address.TcpIpAddress  tcpip_address )

static

Definition at line 68 of file grpc_channelz.py.

is_sock_tcpip_address()

def framework.rpc.grpc_channelz.ChannelzServiceClient.is_sock_tcpip_address ( Address  address )

static

Definition at line 64 of file grpc_channelz.py.

list_channel_sockets()

Iterator[Socket] framework.rpc.grpc_channelz.ChannelzServiceClient.list_channel_sockets	(		self,
		Channel	channel,
		**	kwargs
	)

List all sockets of all subchannels of a given channel.

Definition at line 175 of file grpc_channelz.py.

list_channel_subchannels()

Iterator[Subchannel] framework.rpc.grpc_channelz.ChannelzServiceClient.list_channel_subchannels	(		self,
		Channel	channel,
		**	kwargs
	)

List all subchannels of a given channel.

Definition at line 181 of file grpc_channelz.py.

list_channels()

Iterator[Channel] framework.rpc.grpc_channelz.ChannelzServiceClient.list_channels	(		self,
		**	kwargs
	)

Iterate over all pages of all root channels.

Root channels are those which application has directly created.
This does not include subchannels nor non-top level channels.

Definition at line 116 of file grpc_channelz.py.

list_server_sockets()

Iterator[Socket] framework.rpc.grpc_channelz.ChannelzServiceClient.list_server_sockets	(		self,
		Server	server,
		**	kwargs
	)

List all server sockets that exist in server process.

Iterating over the results will resolve additional pages automatically.

Definition at line 153 of file grpc_channelz.py.

list_servers()

Iterator[Server] framework.rpc.grpc_channelz.ChannelzServiceClient.list_servers	(		self,
		**	kwargs
	)

Iterate over all pages of all servers that exist in the process.

Definition at line 137 of file grpc_channelz.py.

list_subchannels_sockets()

Iterator[Socket] framework.rpc.grpc_channelz.ChannelzServiceClient.list_subchannels_sockets	(		self,
		Subchannel	subchannel,
		**	kwargs
	)

List all sockets of a given subchannel.

Definition at line 187 of file grpc_channelz.py.

sock_address_to_str()

def framework.rpc.grpc_channelz.ChannelzServiceClient.sock_address_to_str	(		cls,
		Address	address
	)

Definition at line 74 of file grpc_channelz.py.

sock_addresses_pretty()

def framework.rpc.grpc_channelz.ChannelzServiceClient.sock_addresses_pretty	(		cls,
		Socket	socket
	)

Definition at line 86 of file grpc_channelz.py.

---

The documentation for this class was generated from the following file:

• grpc_channelz.py