nvflare.fuel.f3.drivers.tcp_driver module

class TcpDriver

Bases: BaseDriver

static capabilities() → Dict[str, Any]

Return a dictionary of capabilities of the driver.

connect(connector: ConnectorInfo)

Start the driver in active mode

Parameters:

connector – Connector with parameters

Raises:

CommError – If any errors

static get_urls(scheme: str, resources: dict) -> (<class 'str'>, <class 'str'>)

Get active and passive URL pair based on resources

Parameters:

• scheme – A scheme supported by the driver, like http or https

• resources – User specified resources like host and port ranges.

Returns:

A tuple with active and passive URLs

Raises:

CommError – If no free port can be found

listen(connector: ConnectorInfo)

Start the driver in passive mode

Parameters:

connector – Connector with parameters

Raises:

CommError – If any errors

shutdown()

Stop driver and disconnect all the connections created by it

Raises:

CommError – If any errors

static supported_transports() → List[str]

Return a list of transports supported by this driver, for example [“http”, “https”, “ws”, “wss”]

class TcpStreamServer(driver: Driver, connector: ConnectorInfo)

Bases: ThreadingTCPServer

Constructor. May be extended, do not override.