nvflare.fuel.hci.client.api_spec module

class AdminAPISpec[source]

Bases: ABC

get_command_result()[source]

Gets the result returning from executing the command.

abstract server_execute(command: str, reply_processor: Optional[ReplyProcessor] = None)[source]

Executes a command on server side.

Parameters

  • command – The command to be executed.

  • reply_processor – Reply callback to use.

set_command_result(result)[source]

Sets the result returning from executing the command.

class ReplyProcessor[source]

Bases: object

A base class for parsing server’s response.

process_dict(api: AdminAPISpec, data: dict)[source]
process_error(api: AdminAPISpec, err: str)[source]
process_shutdown(api: AdminAPISpec, msg: str)[source]
process_string(api: AdminAPISpec, item: str)[source]
process_success(api: AdminAPISpec, item: str)[source]
process_table(api: AdminAPISpec, table: Table)[source]
process_token(api: AdminAPISpec, token: str)[source]
protocol_error(api: AdminAPISpec, err: str)[source]
reply_done(api: AdminAPISpec)[source]
reply_start(api: AdminAPISpec, reply_json)[source]