nvflare.fuel.hci.client.event module

class EventContext

Bases: SimpleContext

A simple context containing a props dictionary of key value pairs and convenience methods.

get_custom_prop(key: str, default)

set_custom_prop(key: str, value)

class EventHandler

Bases: ABC

abstract handle_event(event_type: str, ctx: SimpleContext)

class EventPropKey

Bases: object

API = 'api'

CMD_CTX = 'cmd_ctx'

CMD_NAME = 'cmd_name'

CUSTOM_PROPS = 'custom_props'

MSG = 'msg'

USER_NAME = 'user_name'

class EventType

Bases: object

AFTER_DOWNLOAD_FILE = 'after_download_file'

BEFORE_DOWNLOAD_FILE = 'before_download_file'

BEFORE_EXECUTE_CMD = 'before_execute_cmd'

BEFORE_LOGIN = 'before_login'

LOGIN_FAILURE = 'login_failure'

LOGIN_SUCCESS = 'login_success'

SESSION_TIMEOUT = 'session_timeout'

TRYING_LOGIN = 'trying_login'