nvflare.fuel.hci.client package

Submodules

• nvflare.fuel.hci.client.api module
  • AdminAPI
    • AdminAPI.auto_login()
    • AdminAPI.check_command()
    • AdminAPI.check_session_status_on_server()
    • AdminAPI.close()
    • AdminAPI.debug()
    • AdminAPI.do_command()
    • AdminAPI.fire_event()
    • AdminAPI.fire_session_event()
    • AdminAPI.is_ready()
    • AdminAPI.login()
    • AdminAPI.login_with_insecure()
    • AdminAPI.logout()
    • AdminAPI.register_command()
    • AdminAPI.server_execute()
    • AdminAPI.set_command_timeout()
    • AdminAPI.unset_command_timeout()
  • ResultKey
    • 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()
  • ApiPocValue
    • ApiPocValue.ADMIN
  • CommandContext
    • CommandContext.get_api()
    • CommandContext.get_bytes_receiver()
    • CommandContext.get_bytes_sender()
    • CommandContext.get_command()
    • CommandContext.get_command_args()
    • CommandContext.get_command_entry()
    • 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.set_api()
    • CommandContext.set_bytes_receiver()
    • CommandContext.set_bytes_sender()
    • CommandContext.set_command()
    • CommandContext.set_command_args()
    • CommandContext.set_command_entry()
    • CommandContext.set_command_props()
    • CommandContext.set_command_result()
    • CommandContext.set_custom_props()
    • CommandContext.set_json_processor()
    • CommandContext.set_meta()
    • CommandContext.set_reply_processor()
  • CommandCtxKey
    • CommandCtxKey.API
    • CommandCtxKey.BYTES_RECEIVER
    • CommandCtxKey.BYTES_SENDER
    • CommandCtxKey.CMD
    • CommandCtxKey.CMD_ARGS
    • CommandCtxKey.CMD_ENTRY
    • CommandCtxKey.CMD_PROPS
    • CommandCtxKey.CUSTOM_PROPS
    • CommandCtxKey.JSON_PROCESSOR
    • CommandCtxKey.META
    • CommandCtxKey.REPLY_PROCESSOR
    • CommandCtxKey.RESULT
  • CommandInfo
    • CommandInfo.AMBIGUOUS
    • CommandInfo.CONFIRM_AUTH
    • CommandInfo.CONFIRM_PWD
    • CommandInfo.CONFIRM_USER_NAME
    • CommandInfo.CONFIRM_YN
    • CommandInfo.OK
    • CommandInfo.UNKNOWN
  • ReceiveBytesFromServer
    • ReceiveBytesFromServer.receive()
  • 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()
  • SendBytesToServer
    • SendBytesToServer.send()
  • ServiceFinder
    • ServiceFinder.get_command_module()
    • ServiceFinder.set_secure_context()
    • ServiceFinder.start()
    • ServiceFinder.stop()
  • service_address_changed_cb_signature()
• 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.process_config_element()
    • FLAdminClientStarterConfigurator.start_config()
• nvflare.fuel.hci.client.event module
  • EventContext
    • EventContext.get_custom_prop()
    • EventContext.set_custom_prop()
  • EventHandler
    • EventHandler.handle_event()
  • EventPropKey
    • 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.SERVER_ADDR_OBTAINED
    • EventType.SESSION_CLOSED
    • EventType.SESSION_TIMEOUT
    • EventType.SP_ADDR_CHANGED
    • EventType.TRYING_LOGIN
    • EventType.WAIT_FOR_SERVER_ADDR
• nvflare.fuel.hci.client.file_transfer module
  • FileTransferModule
    • FileTransferModule.download_binary_file()
    • FileTransferModule.download_file()
    • FileTransferModule.download_folder()
    • FileTransferModule.download_text_file()
    • FileTransferModule.generate_module_spec()
    • FileTransferModule.get_spec()
    • FileTransferModule.info()
    • FileTransferModule.pull_binary_file()
    • FileTransferModule.pull_folder()
    • FileTransferModule.push_folder()
    • FileTransferModule.upload_binary_file()
    • FileTransferModule.upload_file()
    • FileTransferModule.upload_text_file()
• nvflare.fuel.hci.client.fl_admin_api module
  • FLAdminAPI
    • FLAdminAPI.abort()
    • FLAdminAPI.abort_job()
    • FLAdminAPI.cat_target()
    • FLAdminAPI.check_status()
    • FLAdminAPI.clone_job()
    • FLAdminAPI.delete_job()
    • FLAdminAPI.download_job()
    • FLAdminAPI.get_active_sp()
    • FLAdminAPI.get_available_apps_to_upload()
    • FLAdminAPI.get_connected_client_list()
    • FLAdminAPI.get_working_directory()
    • FLAdminAPI.grep_target()
    • FLAdminAPI.list_jobs()
    • FLAdminAPI.list_sp()
    • FLAdminAPI.ls_target()
    • FLAdminAPI.promote_sp()
    • FLAdminAPI.remove_client()
    • FLAdminAPI.reset_errors()
    • FLAdminAPI.restart()
    • FLAdminAPI.set_timeout()
    • FLAdminAPI.show_errors()
    • FLAdminAPI.show_stats()
    • FLAdminAPI.shutdown()
    • FLAdminAPI.shutdown_system()
    • FLAdminAPI.submit_job()
    • FLAdminAPI.tail_target_log()
    • FLAdminAPI.wait_until_client_status()
    • FLAdminAPI.wait_until_server_stats()
    • FLAdminAPI.wait_until_server_status()
    • FLAdminAPI.write_error()
  • default_client_status_handling_cb()
  • default_server_status_handling_cb()
  • default_stats_handling_cb()
  • wrap_with_return_exception_responses()
• nvflare.fuel.hci.client.fl_admin_api_constants module
  • FLDetailKey
    • FLDetailKey.APP_NAME
    • FLDetailKey.CLIENT_LOG
    • FLDetailKey.CONNECTED_CLIENTS
    • FLDetailKey.REGISTERED_CLIENTS
    • FLDetailKey.RESPONSES
    • FLDetailKey.SERVER_ENGINE_STATUS
    • FLDetailKey.SERVER_LOG
    • FLDetailKey.STATUS_TABLE
    • FLDetailKey.SUBMITTED_MODELS
• nvflare.fuel.hci.client.fl_admin_api_runner module
  • FLAdminAPIRunner
    • FLAdminAPIRunner.run()
  • api_command_wrapper()
• nvflare.fuel.hci.client.fl_admin_api_spec module
  • APISyntaxError
  • FLAdminAPIResponse
  • FLAdminAPISpec
    • FLAdminAPISpec.abort()
    • FLAdminAPISpec.abort_job()
    • FLAdminAPISpec.cat_target()
    • FLAdminAPISpec.check_status()
    • FLAdminAPISpec.clone_job()
    • FLAdminAPISpec.delete_job()
    • FLAdminAPISpec.download_job()
    • FLAdminAPISpec.get_active_sp()
    • FLAdminAPISpec.get_available_apps_to_upload()
    • FLAdminAPISpec.get_connected_client_list()
    • FLAdminAPISpec.get_working_directory()
    • FLAdminAPISpec.grep_target()
    • FLAdminAPISpec.list_jobs()
    • FLAdminAPISpec.list_sp()
    • FLAdminAPISpec.ls_target()
    • FLAdminAPISpec.promote_sp()
    • FLAdminAPISpec.remove_client()
    • FLAdminAPISpec.reset_errors()
    • FLAdminAPISpec.restart()
    • FLAdminAPISpec.set_timeout()
    • FLAdminAPISpec.show_errors()
    • FLAdminAPISpec.show_stats()
    • FLAdminAPISpec.shutdown()
    • FLAdminAPISpec.submit_job()
    • FLAdminAPISpec.tail_target_log()
    • FLAdminAPISpec.wait_until_server_status()
  • TargetType
    • TargetType.ALL
    • TargetType.CLIENT
    • TargetType.SERVER
• nvflare.fuel.hci.client.overseer_service_finder module
  • ServiceFinderByOverseer
    • ServiceFinderByOverseer.get_command_module()
    • ServiceFinderByOverseer.set_secure_context()
    • ServiceFinderByOverseer.start()
    • ServiceFinderByOverseer.stop()
• nvflare.fuel.hci.client.rr_service_finder module
  • RRServiceFinder
    • RRServiceFinder.start()
    • RRServiceFinder.stop()
• nvflare.fuel.hci.client.static_service_finder module
  • StaticServiceFinder
    • StaticServiceFinder.start()
    • StaticServiceFinder.stop()

Module contents