Public Member Functions | Public Attributes | List of all members
framework.test_app.client_app.XdsTestClient Class Reference
Inheritance diagram for framework.test_app.client_app.XdsTestClient:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, *str ip, int rpc_port, str server_target, Optional[str] rpc_host=None, Optional[int] maintenance_port=None)
 
_ChannelzServiceClient channelz (self)
 
_CsdsClient csds (self)
 
_ChannelzChannel find_server_channel_with_state (self, _ChannelzChannelState state, *Optional[_timedelta] rpc_deadline=None, check_subchannel=True)
 
_ChannelzSubchannel find_subchannel_with_state (self, _ChannelzChannel channel, _ChannelzChannelState state, **kwargs)
 
List[_ChannelzSubchannelfind_subchannels_with_state (self, _ChannelzChannelState state, **kwargs)
 
_ChannelzSocket get_active_server_channel_socket (self)
 
grpc_testing.LoadBalancerAccumulatedStatsResponse get_load_balancer_accumulated_stats (self, *Optional[int] timeout_sec=None)
 
grpc_testing.LoadBalancerStatsResponse get_load_balancer_stats (self, *int num_rpcs, Optional[int] timeout_sec=None)
 
Iterable[_ChannelzChannelget_server_channels (self, **kwargs)
 
_LoadBalancerStatsServiceClient load_balancer_stats (self)
 
def update_config (self)
 
_ChannelzChannel wait_for_active_server_channel (self)
 
_ChannelzChannel wait_for_server_channel_state (self, _ChannelzChannelState state, *Optional[_timedelta] timeout=None, Optional[_timedelta] rpc_deadline=None)
 
- Public Member Functions inherited from framework.rpc.grpc.GrpcApp
def __del__ (self)
 
def __enter__ (self)
 
def __exit__ (self, exc_type, exc_val, exc_tb)
 
def __init__ (self, rpc_host)
 
def close (self)
 

Public Attributes

 ip
 
 maintenance_port
 
 rpc_port
 
 server_target
 
- Public Attributes inherited from framework.rpc.grpc.GrpcApp
 channels
 
 rpc_host
 

Detailed Description

Represents RPC services implemented in Client component of the xds test app.
https://github.com/grpc/grpc/blob/master/doc/xds-test-descriptions.md#client

Definition at line 48 of file client_app.py.

Constructor & Destructor Documentation

◆ __init__()

def framework.test_app.client_app.XdsTestClient.__init__ (   self,
*str  ip,
int  rpc_port,
str  server_target,
Optional[str]   rpc_host = None,
Optional[int]   maintenance_port = None 
)

Definition at line 54 of file client_app.py.

Member Function Documentation

◆ channelz()

_ChannelzServiceClient framework.test_app.client_app.XdsTestClient.channelz (   self)

Definition at line 81 of file client_app.py.

◆ csds()

_CsdsClient framework.test_app.client_app.XdsTestClient.csds (   self)

Definition at line 86 of file client_app.py.

◆ find_server_channel_with_state()

_ChannelzChannel framework.test_app.client_app.XdsTestClient.find_server_channel_with_state (   self,
_ChannelzChannelState  state,
*Optional[_timedelta]   rpc_deadline = None,
  check_subchannel = True 
)

Definition at line 166 of file client_app.py.

◆ find_subchannel_with_state()

_ChannelzSubchannel framework.test_app.client_app.XdsTestClient.find_subchannel_with_state (   self,
_ChannelzChannel  channel,
_ChannelzChannelState  state,
**  kwargs 
)

Definition at line 204 of file client_app.py.

◆ find_subchannels_with_state()

List[_ChannelzSubchannel] framework.test_app.client_app.XdsTestClient.find_subchannels_with_state (   self,
_ChannelzChannelState  state,
**  kwargs 
)

Definition at line 216 of file client_app.py.

◆ get_active_server_channel_socket()

_ChannelzSocket framework.test_app.client_app.XdsTestClient.get_active_server_channel_socket (   self)

Definition at line 118 of file client_app.py.

◆ get_load_balancer_accumulated_stats()

grpc_testing.LoadBalancerAccumulatedStatsResponse framework.test_app.client_app.XdsTestClient.get_load_balancer_accumulated_stats (   self,
*Optional[int]   timeout_sec = None 
)
Shortcut to LoadBalancerStatsServiceClient.get_client_accumulated_stats()

Definition at line 101 of file client_app.py.

◆ get_load_balancer_stats()

grpc_testing.LoadBalancerStatsResponse framework.test_app.client_app.XdsTestClient.get_load_balancer_stats (   self,
*int  num_rpcs,
Optional[int]   timeout_sec = None 
)
Shortcut to LoadBalancerStatsServiceClient.get_client_stats()

Definition at line 89 of file client_app.py.

◆ get_server_channels()

Iterable[_ChannelzChannel] framework.test_app.client_app.XdsTestClient.get_server_channels (   self,
**  kwargs 
)

Definition at line 200 of file client_app.py.

◆ load_balancer_stats()

_LoadBalancerStatsServiceClient framework.test_app.client_app.XdsTestClient.load_balancer_stats (   self)

Definition at line 69 of file client_app.py.

◆ update_config()

def framework.test_app.client_app.XdsTestClient.update_config (   self)

Definition at line 75 of file client_app.py.

◆ wait_for_active_server_channel()

_ChannelzChannel framework.test_app.client_app.XdsTestClient.wait_for_active_server_channel (   self)
Wait for the channel to the server to transition to READY.

Raises:
    GrpcApp.NotFound: If the channel never transitioned to READY.

Definition at line 110 of file client_app.py.

◆ wait_for_server_channel_state()

_ChannelzChannel framework.test_app.client_app.XdsTestClient.wait_for_server_channel_state (   self,
_ChannelzChannelState  state,
*Optional[_timedelta]   timeout = None,
Optional[_timedelta]   rpc_deadline = None 
)

Definition at line 138 of file client_app.py.

Member Data Documentation

◆ ip

framework.test_app.client_app.XdsTestClient.ip

Definition at line 56 of file client_app.py.

◆ maintenance_port

framework.test_app.client_app.XdsTestClient.maintenance_port

Definition at line 59 of file client_app.py.

◆ rpc_port

framework.test_app.client_app.XdsTestClient.rpc_port

Definition at line 57 of file client_app.py.

◆ server_target

framework.test_app.client_app.XdsTestClient.server_target

Definition at line 58 of file client_app.py.


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


grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:10