nvflare.fuel.hci.client package

Submodules

• nvflare.fuel.hci.client.api module
  • AdminAPI
    • AdminAPI.check_command()
    • AdminAPI.close()
    • AdminAPI.connect()
    • AdminAPI.debug()
    • AdminAPI.do_command()
    • AdminAPI.download_file()
    • AdminAPI.fire_event()
    • AdminAPI.fire_session_event()
    • AdminAPI.get_cell()
    • AdminAPI.is_ready()
    • AdminAPI.login()
    • AdminAPI.logout()
    • AdminAPI.new_context()
    • AdminAPI.register_command()
    • AdminAPI.register_stream_processing()
    • AdminAPI.server_execute()
    • AdminAPI.set_command_timeout()
    • AdminAPI.shutdown_streamer()
    • AdminAPI.stream_objects()
    • AdminAPI.unset_command_timeout()
    • AdminAPI.upload_file()
  • FileWaiter
    • FileWaiter.get_stream_ctx()
  • ResultKey
    • ResultKey.AUTH_CODE
    • ResultKey.DETAILS
    • ResultKey.META
    • ResultKey.STATUS
• nvflare.fuel.hci.client.api_spec module
  • AdminAPISpec
    • AdminAPISpec.check_command()
    • AdminAPISpec.do_command()
    • AdminAPISpec.is_ready()
    • AdminAPISpec.server_execute()
  • AdminConfigKey
    • AdminConfigKey.ADMIN
    • AdminConfigKey.AUTHENTICATE_MSG_TIMEOUT
    • AdminConfigKey.CA_CERT
    • AdminConfigKey.CLIENT_CERT
    • AdminConfigKey.CLIENT_KEY
    • AdminConfigKey.CLI_HISTORY_SIZE
    • AdminConfigKey.CONNECTION_SCHEME
    • AdminConfigKey.CONNECTION_SECURITY
    • AdminConfigKey.DOWNLOAD_DIR
    • AdminConfigKey.FILE_DOWNLOAD_PROGRESS_TIMEOUT
    • AdminConfigKey.HOST
    • AdminConfigKey.IDENTITY
    • AdminConfigKey.IDLE_TIMEOUT
    • AdminConfigKey.LOGIN_TIMEOUT
    • AdminConfigKey.PORT
    • AdminConfigKey.PROJECT_NAME
    • AdminConfigKey.PROMPT
    • AdminConfigKey.SERVER_IDENTITY
    • AdminConfigKey.UID_SOURCE
    • AdminConfigKey.UPLOAD_DIR
    • AdminConfigKey.USERNAME
    • AdminConfigKey.WITH_DEBUG
    • AdminConfigKey.WITH_FILE_TRANSFER
  • ApiPocValue
    • ApiPocValue.ADMIN
  • CommandContext
    • CommandContext.get_api()
    • CommandContext.get_command()
    • CommandContext.get_command_args()
    • CommandContext.get_command_entry()
    • CommandContext.get_command_headers()
    • CommandContext.get_command_name()
    • CommandContext.get_command_props()
    • CommandContext.get_command_result()
    • CommandContext.get_custom_props()
    • CommandContext.get_json_processor()
    • CommandContext.get_meta()
    • CommandContext.get_reply_processor()
    • CommandContext.get_requester()
    • CommandContext.set_api()
    • CommandContext.set_command()
    • CommandContext.set_command_args()
    • CommandContext.set_command_entry()
    • CommandContext.set_command_headers()
    • CommandContext.set_command_props()
    • CommandContext.set_command_result()
    • CommandContext.set_custom_props()
    • CommandContext.set_json_processor()
    • CommandContext.set_meta()
    • CommandContext.set_reply_processor()
    • CommandContext.set_requester()
  • CommandCtxKey
    • CommandCtxKey.API
    • CommandCtxKey.CMD
    • CommandCtxKey.CMD_ARGS
    • CommandCtxKey.CMD_ENTRY
    • CommandCtxKey.CMD_HEADERS
    • CommandCtxKey.CMD_PROPS
    • CommandCtxKey.CUSTOM_PROPS
    • CommandCtxKey.JSON_PROCESSOR
    • CommandCtxKey.META
    • CommandCtxKey.REPLY_PROCESSOR
    • CommandCtxKey.REQUESTER
    • CommandCtxKey.RESULT
  • CommandInfo
    • CommandInfo.AMBIGUOUS
    • CommandInfo.CONFIRM_AUTH
    • CommandInfo.CONFIRM_USER_NAME
    • CommandInfo.CONFIRM_YN
    • CommandInfo.OK
    • CommandInfo.UNKNOWN
  • HCIRequester
    • HCIRequester.send_request()
  • ReplyProcessor
    • ReplyProcessor.process_bytes()
    • ReplyProcessor.process_dict()
    • ReplyProcessor.process_error()
    • ReplyProcessor.process_shutdown()
    • ReplyProcessor.process_string()
    • ReplyProcessor.process_success()
    • ReplyProcessor.process_table()
    • ReplyProcessor.process_token()
    • ReplyProcessor.protocol_error()
    • ReplyProcessor.reply_done()
    • ReplyProcessor.reply_start()
  • UidSource
    • UidSource.CERT
    • UidSource.GUEST
    • UidSource.USER_INPUT
• nvflare.fuel.hci.client.api_status module
  • APIStatus
    • APIStatus.ERROR_AUTHENTICATION
    • APIStatus.ERROR_AUTHORIZATION
    • APIStatus.ERROR_CERT
    • APIStatus.ERROR_INACTIVE_SESSION
    • APIStatus.ERROR_INVALID_CLIENT
    • APIStatus.ERROR_PROTOCOL
    • APIStatus.ERROR_RUNTIME
    • APIStatus.ERROR_SERVER_CONNECTION
    • APIStatus.ERROR_SYNTAX
    • APIStatus.SUCCESS
• nvflare.fuel.hci.client.cli module
  • AdminClient
    • AdminClient.cmdloop()
    • AdminClient.complete()
    • AdminClient.default()
    • AdminClient.do_bye()
    • AdminClient.do_help()
    • AdminClient.do_lpwd()
    • AdminClient.do_timeout()
    • AdminClient.emptyline()
    • AdminClient.flush()
    • AdminClient.handle_event()
    • AdminClient.postcmd()
    • AdminClient.preloop()
    • AdminClient.print_resp()
    • AdminClient.run()
    • AdminClient.session_signal_handler()
    • AdminClient.write_dict()
    • AdminClient.write_error()
    • AdminClient.write_stdout()
    • AdminClient.write_string()
    • AdminClient.write_table()
• nvflare.fuel.hci.client.config module
  • FLAdminClientStarterConfigurator
    • FLAdminClientStarterConfigurator.get_admin_config()
    • FLAdminClientStarterConfigurator.process_config_element()
    • FLAdminClientStarterConfigurator.start_config()
  • secure_load_admin_config()
• nvflare.fuel.hci.client.event module
  • EventContext
    • EventContext.get_custom_prop()
    • EventContext.set_custom_prop()
  • EventHandler
    • EventHandler.handle_event()
  • EventPropKey
    • EventPropKey.API
    • EventPropKey.CMD_CTX
    • EventPropKey.CMD_NAME
    • EventPropKey.CUSTOM_PROPS
    • EventPropKey.MSG
    • EventPropKey.USER_NAME
  • EventType
    • EventType.AFTER_DOWNLOAD_FILE
    • EventType.BEFORE_DOWNLOAD_FILE
    • EventType.BEFORE_EXECUTE_CMD
    • EventType.BEFORE_LOGIN
    • EventType.LOGIN_FAILURE
    • EventType.LOGIN_SUCCESS
    • EventType.SESSION_TIMEOUT
    • EventType.TRYING_LOGIN
• nvflare.fuel.hci.client.file_transfer module
  • FileTransferModule
    • FileTransferModule.PULL_BINARY_FILE_CMD
    • FileTransferModule.generate_module_spec()
    • FileTransferModule.get_spec()
    • FileTransferModule.info()
    • FileTransferModule.pull_binary_file()
    • FileTransferModule.pull_folder()
    • FileTransferModule.push_folder()

Module contents