nvflare.private.fed.server.server_aux_runner module

class ServerAuxRunner[source]

Bases: AuxRunner

This class is for auxiliary channel communication on server side.

Note: The ServerEngine must create a new ServerAuxRunner object for each RUN, and make sure

it is added as an event handler.

send_aux_request(targets: [], topic: str, request: Shareable, timeout: float, fl_ctx: FLContext) → dict[source]

Send request through auxiliary channel.

Parameters

  • targets (list) – list of client names that the request will be sent to

  • topic (str) – topic of the request

  • request (Shareable) – request

  • timeout (float) – how long to wait for result. 0 means fire-and-forget

  • fl_ctx (FLContext) – the FL context

Returns

A dict of results