nvflare.fuel.f3.endpoint module

class Endpoint(name: str, properties: dict | None = None, conn_props: dict | None = None)

Bases: object

Endpoint represents a logical party in the SFM network. For each communicator, there is only one local endpoint. There may be multiple remote endpoints. A remote endpoint may be reachable through multiple connections

Construct an endpoint

Parameters:

• name – The endpoint name

• properties – Public properties exchanged with peer

• conn_props – Connection properties and local credentials like certificates

Raises:

CommError – If any error happens while sending the request

get_prop(key)

set_prop(key, value)

class EndpointMonitor

Bases: ABC

Monitor for endpoint lifecycle changes

abstract state_change(endpoint: Endpoint)

class EndpointState(value)

Bases: IntEnum

An enumeration.

CLOSING = 2

DISCONNECTED = 3

ERROR = 4

IDLE = 0

READY = 1