framework.test_app.server_app.XdsTestServer Class Reference

Inheritance diagram for framework.test_app.server_app.XdsTestServer:

Public Member Functions
def	__init__ (self, *str ip, int rpc_port, Optional[int] maintenance_port=None, Optional[bool] secure_mode=False, Optional[str] server_id=None, Optional[str] xds_host=None, Optional[int] xds_port=None, Optional[str] rpc_host=None, Optional[str] pod_name=None)
_ChannelzServiceClient	channelz (self)
def	get_server_socket_matching_client (self, grpc_channelz.Socket client_socket)
grpc_channelz.Server	get_test_server (self)
Iterator[grpc_channelz.Socket]	get_test_server_sockets (self)
_HealthClient	health_client (self)
def	set_not_serving (self)
def	set_serving (self)
def	set_xds_address (self, xds_host, Optional[int] xds_port=None)
_XdsUpdateHealthServiceClient	update_health_service_client (self)
str	xds_address (self)
str	xds_uri (self)
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
	pod_name
	rpc_port
	secure_mode
	server_id
	xds_port
Public Attributes inherited from framework.rpc.grpc.GrpcApp
	channels
	rpc_host

Detailed Description

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

Definition at line 39 of file server_app.py.

Constructor & Destructor Documentation

__init__()

def framework.test_app.server_app.XdsTestServer.__init__	(		self,
		*str	ip,
		int	rpc_port,
		Optional[int]	maintenance_port = None,
		Optional[bool]	secure_mode = False,
		Optional[str]	server_id = None,
		Optional[str]	xds_host = None,
		Optional[int]	xds_port = None,
		Optional[str]	rpc_host = None,
		Optional[str]	pod_name = None
	)

Definition at line 45 of file server_app.py.

Member Function Documentation

channelz()

_ChannelzServiceClient framework.test_app.server_app.XdsTestServer.channelz

(

self

)

Definition at line 67 of file server_app.py.

get_server_socket_matching_client()

def framework.test_app.server_app.XdsTestServer.get_server_socket_matching_client	(		self,
		grpc_channelz.Socket	client_socket
	)

Find test server socket that matches given test client socket.

Sockets are matched using TCP endpoints (ip:port), further on "address".
Server socket remote address matched with client socket local address.

 Raises:
     GrpcApp.NotFound: Server socket matching client socket not found.

Definition at line 129 of file server_app.py.

get_test_server()

grpc_channelz.Server framework.test_app.server_app.XdsTestServer.get_test_server

(

self

)

Return channelz representation of a server running TestService.

Raises:
    GrpcApp.NotFound: Test server not found.

Definition at line 108 of file server_app.py.

get_test_server_sockets()

Iterator[grpc_channelz.Socket] framework.test_app.server_app.XdsTestServer.get_test_server_sockets

(

self

)

List all sockets of the test server.

Raises:
    GrpcApp.NotFound: Test server not found.

Definition at line 120 of file server_app.py.

health_client()

_HealthClient framework.test_app.server_app.XdsTestServer.health_client

(

self

)

Definition at line 78 of file server_app.py.

set_not_serving()

def framework.test_app.server_app.XdsTestServer.set_not_serving

(

self

)

Definition at line 86 of file server_app.py.

set_serving()

def framework.test_app.server_app.XdsTestServer.set_serving

(

self

)

Definition at line 81 of file server_app.py.

set_xds_address()

def framework.test_app.server_app.XdsTestServer.set_xds_address	(		self,
			xds_host,
		Optional[int]	xds_port = None
	)

Definition at line 91 of file server_app.py.

update_health_service_client()

_XdsUpdateHealthServiceClient framework.test_app.server_app.XdsTestServer.update_health_service_client

(

self

)

Definition at line 72 of file server_app.py.

xds_address()

str framework.test_app.server_app.XdsTestServer.xds_address

(

self

)

Definition at line 95 of file server_app.py.

xds_uri()

str framework.test_app.server_app.XdsTestServer.xds_uri

(

self

)

Definition at line 103 of file server_app.py.

Member Data Documentation

ip

framework.test_app.server_app.XdsTestServer.ip

Definition at line 47 of file server_app.py.

maintenance_port

framework.test_app.server_app.XdsTestServer.maintenance_port

Definition at line 49 of file server_app.py.

pod_name

framework.test_app.server_app.XdsTestServer.pod_name

Definition at line 53 of file server_app.py.

rpc_port

framework.test_app.server_app.XdsTestServer.rpc_port

Definition at line 48 of file server_app.py.

secure_mode

framework.test_app.server_app.XdsTestServer.secure_mode

Definition at line 50 of file server_app.py.

server_id

framework.test_app.server_app.XdsTestServer.server_id

Definition at line 51 of file server_app.py.

xds_port

framework.test_app.server_app.XdsTestServer.xds_port

Definition at line 52 of file server_app.py.

---

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

• server_app.py