fl4health.servers.polling module

poll_client(client, ins)

Get Properties of client. This is run for each client to extract the properties from the target client.

Parameters:

• client (ClientProxy) – Client proxy representing one of the clients managed by the server.

• ins (GetPropertiesIns) – ins provides any configurations required to help the client retrieve the correct properties.

Returns:

Returns the resulting properties from the client response.

Return type:

tuple[ClientProxy, GetPropertiesRes]

poll_clients(client_instructions, max_workers, timeout)

Poll clients concurrently on all selected clients.

Parameters:

• client_instructions (list[tuple[ClientProxy, GetPropertiesIns]]) – This is the set of instructions for the polling to be passed to each client. Each client is represented by a single ClientProxy in the list.

• max_workers (int | None) – This is the maximum number of concurrent workers to be used by the server to poll the clients. This should be set if pooling an extremely large number, if none a maximum of 32 workers are used.

• timeout (float | None) – How long the executor should wait to receive a response before moving on.

Returns:

Object holding the results and failures associate with the concurrent polling.

Return type:

PollResultsAndFailures