nvflare.widgets.fed_event module

class ClientFedEventRunner(topic='fed.event')

Bases: FedEventRunner

Init ClientFedEventRunner.

fire_and_forget_request(request: Shareable, fl_ctx: FLContext, targets=None, secure=False)

handle_event(event_type: str, fl_ctx: FLContext)

Handles events.

Parameters:

• event_type (str) – event type fired by workflow.

• fl_ctx (FLContext) – FLContext information.

class FedEventRunner(topic='fed.event', regular_interval=0.01, grace_period=2.0, queue_empty_period=2.0)

Bases: Widget

Init FedEventRunner.

The FedEventRunner handles posting and receiving of fed events. The system will do its best to fire off all events in the queue before shutdown using the ABOUT_TO_END_RUN event and a grace period during END_RUN.

Parameters:

topic – the fed event topic to be handled. Defaults to ‘fed.event’

fire_and_forget_request(request: Shareable, fl_ctx: FLContext, targets=None, secure=False)

handle_event(event_type: str, fl_ctx: FLContext)

Handles events.

Parameters:

• event_type (str) – event type fired by workflow.

• fl_ctx (FLContext) – FLContext information.

class ServerFedEventRunner(topic='fed.event', regular_interval=0.01, grace_period=2.0, queue_empty_period=2.0)

Bases: FedEventRunner

Init ServerFedEventRunner.

fire_and_forget_request(request: Shareable, fl_ctx: FLContext, targets=None, secure=False)