p2pfl.communication.protocols.protobuff.neighbors module

Protocol agnostic neighbor management.

class p2pfl.communication.protocols.protobuff.neighbors.Neighbors(build_client_fn)

Bases: NodeComponent

Neighbor management class for agnostic communication protocol.

Parameters:

build_client_fn (Callable[..., ProtobuffClient])

add(addr, non_direct=False, handshake=True)

Add a neighbor to the neighbors list.

Parameters:

• addr (str) – Address of the neighbor to add.

• non_direct (bool) – Flag to add a non-direct neighbor.

• handshake (bool) – Flag to perform a handshake.

Return type:

bool

Returns:

True if the neighbor was added, False otherwise.

clear_neighbors()

Clear all neighbors.

Return type:

None

exists(addr, only_direct=False)

Check if a neighbor exists in the neighbors list.

Parameters:

• addr (str) – Address of the neighbor to check.

• only_direct (bool) – Flag to check only direct neighbors.

Return type:

bool

get(addr)

Get a neighbor from the neighbors list.

Parameters:

addr (str) – Address of the neighbor to get.

Return type:

ProtobuffClient

Returns:

The neighbor.

get_all(only_direct=False)

Get all neighbors from the neighbors list.

Parameters:

only_direct (bool) – Flag to get only direct neighbors.

Return type:

dict[str, tuple[ProtobuffClient, float]]

refresh_or_add(addr, time)

Refresh or add a neighbor.

Parameters:

• addr (str) – Address of the neighbor.

• time (float) – Time of the last heartbeat.

Return type:

None

remove(addr, disconnect_msg=True)

Remove a neighbor from the neighbors list.

Be careful, this method does not close the connection, is agnostic to the connection state.

Parameters:

• addr (str) – Address of the neighbor to remove.

• disconnect_msg (bool) – If a disconnect message is needed.

Return type:

None