nvflare.fuel.f3 package

Subpackages

• nvflare.fuel.f3.cellnet package
  • Submodules
    • nvflare.fuel.f3.cellnet.cbs module
      • cell_connected_cb_signature()
      • cell_disconnected_cb_signature()
      • cleanup_cb_signature()
      • filter_cb_signature()
      • message_interceptor_signature()
      • request_cb_signature()
    • nvflare.fuel.f3.cellnet.cell module
      • Adapter
      • Cell
      • SimpleWaiter
    • nvflare.fuel.f3.cellnet.cell_cipher module
      • InvalidCertChain
      • SessionKeyManager
      • SessionKeyUnavailable
      • SimpleCellCipher
      • get_hash()
    • nvflare.fuel.f3.cellnet.connector_manager module
      • ConnectorData
      • ConnectorManager
    • nvflare.fuel.f3.cellnet.core_cell module
      • CellAgent
      • CertificateExchanger
      • CoreCell
      • TargetMessage
      • log_messaging_error()
    • nvflare.fuel.f3.cellnet.credential_manager module
      • CredentialManager
    • nvflare.fuel.f3.cellnet.defs module
      • AbortRun
      • AuthenticationError
      • CellChannel
      • CellChannelTopic
      • CellPropertyKey
      • ConnectorRequirementKey
      • Encoding
      • InvalidRequest
      • InvalidSession
      • MessageHeaderKey
      • MessagePropKey
      • MessageType
      • ReturnCode
      • ReturnReason
      • SSLConstants
      • ServiceUnavailable
      • TargetCellUnreachable
    • nvflare.fuel.f3.cellnet.fqcn module
      • FQCN
      • FqcnInfo
      • same_family()
    • nvflare.fuel.f3.cellnet.net_agent module
      • NetAgent
      • SubnetMonitor
    • nvflare.fuel.f3.cellnet.net_manager module
      • NetManager
    • nvflare.fuel.f3.cellnet.registry module
      • Callback
      • Registry
    • nvflare.fuel.f3.cellnet.utils module
      • buffer_len()
      • decode_payload()
      • encode_payload()
      • format_log_message()
      • format_size()
      • get_msg_header_value()
      • make_reply()
      • shorten_fqcn()
      • shorten_string()
  • Module contents
• nvflare.fuel.f3.drivers package
  • Subpackages
    • nvflare.fuel.f3.drivers.grpc package
      • Submodules
      • Module contents
  • Submodules
    • nvflare.fuel.f3.drivers.aio_conn module
      • AioConnection
    • nvflare.fuel.f3.drivers.aio_context module
      • AioContext
    • nvflare.fuel.f3.drivers.aio_grpc_driver module
      • AioGrpcDriver
      • AioStreamSession
      • Server
      • Servicer
    • nvflare.fuel.f3.drivers.aio_http_driver module
      • AioHttpDriver
      • WsConnection
    • nvflare.fuel.f3.drivers.aio_tcp_driver module
      • AioTcpDriver
    • nvflare.fuel.f3.drivers.base_driver module
      • BaseDriver
    • nvflare.fuel.f3.drivers.connector_info module
      • ConnectorInfo
    • nvflare.fuel.f3.drivers.driver module
      • ConnMonitor
      • Driver
    • nvflare.fuel.f3.drivers.driver_manager module
      • DriverManager
    • nvflare.fuel.f3.drivers.driver_params module
      • DriverCap
      • DriverParams
    • nvflare.fuel.f3.drivers.grpc_driver module
      • GrpcDriver
      • Server
      • Servicer
      • StreamConnection
    • nvflare.fuel.f3.drivers.net_utils module
      • check_tcp_port()
      • encode_url()
      • enhance_credential_info()
      • get_address()
      • get_open_tcp_port()
      • get_ssl_context()
      • get_tcp_urls()
      • parse_port_list()
      • parse_port_range()
      • parse_url()
      • short_url()
      • ssl_required()
    • nvflare.fuel.f3.drivers.socket_conn module
      • ConnectionHandler
      • SocketConnection
    • nvflare.fuel.f3.drivers.tcp_driver module
      • TcpDriver
      • TcpStreamServer
  • Module contents
• nvflare.fuel.f3.sfm package
  • Submodules
    • nvflare.fuel.f3.sfm.conn_manager module
      • ConnManager
      • NullConnection
      • SfmFrameReceiver
      • get_handle()
    • nvflare.fuel.f3.sfm.constants module
      • Flags
      • HandshakeKeys
      • Types
    • nvflare.fuel.f3.sfm.heartbeat_monitor module
      • HeartbeatMonitor
    • nvflare.fuel.f3.sfm.prefix module
      • Prefix
    • nvflare.fuel.f3.sfm.sfm_conn module
      • SfmConnection
    • nvflare.fuel.f3.sfm.sfm_endpoint module
      • SfmEndpoint
  • Module contents
• nvflare.fuel.f3.streaming package
  • Subpackages
    • nvflare.fuel.f3.streaming.tools package
      • Submodules
      • Module contents
  • Submodules
    • nvflare.fuel.f3.streaming.blob_streamer module
      • BlobHandler
      • BlobStream
      • BlobStreamer
      • BlobTask
    • nvflare.fuel.f3.streaming.byte_receiver module
      • ByteReceiver
      • RxStream
      • RxTask
    • nvflare.fuel.f3.streaming.byte_streamer module
      • ByteStreamer
      • TxTask
    • nvflare.fuel.f3.streaming.file_streamer module
      • FileHandler
      • FileStream
      • FileStreamer
    • nvflare.fuel.f3.streaming.object_streamer module
      • ObjectHandler
      • ObjectRxTask
      • ObjectStreamer
      • ObjectTxTask
    • nvflare.fuel.f3.streaming.stream_const module
      • StreamDataType
      • StreamHeaderKey
    • nvflare.fuel.f3.streaming.stream_types module
      • ObjectIterator
      • ObjectStreamFuture
      • Stream
      • StreamCancelled
      • StreamError
      • StreamFuture
    • nvflare.fuel.f3.streaming.stream_utils module
      • FastBuffer
      • gen_stream_id()
      • stream_shutdown()
      • stream_stats_category()
      • wrap_view()
  • Module contents

Submodules

• nvflare.fuel.f3.comm_config module
  • CommConfigurator
    • CommConfigurator.allow_adhoc_connections()
    • CommConfigurator.get_adhoc_connection_scheme()
    • CommConfigurator.get_backbone_connection_generation()
    • CommConfigurator.get_bool_var()
    • CommConfigurator.get_comm_driver_path()
    • CommConfigurator.get_config()
    • CommConfigurator.get_float_var()
    • CommConfigurator.get_heartbeat_interval()
    • CommConfigurator.get_int_var()
    • CommConfigurator.get_internal_connection_scheme()
    • CommConfigurator.get_max_message_size()
    • CommConfigurator.get_str_var()
    • CommConfigurator.get_streaming_ack_interval()
    • CommConfigurator.get_streaming_ack_wait()
    • CommConfigurator.get_streaming_chunk_size()
    • CommConfigurator.get_streaming_max_out_seq_chunks()
    • CommConfigurator.get_streaming_read_timeout()
    • CommConfigurator.get_streaming_window_size()
    • CommConfigurator.get_subnet_heartbeat_interval()
    • CommConfigurator.get_subnet_trouble_threshold()
    • CommConfigurator.reset()
    • CommConfigurator.use_aio_grpc()
  • VarName
    • VarName.ADHOC_CONN_SCHEME
    • VarName.ALLOW_ADHOC_CONNS
    • VarName.BACKBONE_CONN_GEN
    • VarName.COMM_DRIVER_PATH
    • VarName.HEARTBEAT_INTERVAL
    • VarName.INTERNAL_CONN_SCHEME
    • VarName.MAX_MESSAGE_SIZE
    • VarName.STREAMING_ACK_INTERVAL
    • VarName.STREAMING_ACK_WAIT
    • VarName.STREAMING_CHUNK_SIZE
    • VarName.STREAMING_MAX_OUT_SEQ_CHUNKS
    • VarName.STREAMING_READ_TIMEOUT
    • VarName.STREAMING_WINDOW_SIZE
    • VarName.SUBNET_HEARTBEAT_INTERVAL
    • VarName.SUBNET_TROUBLE_THRESHOLD
    • VarName.USE_AIO_GRPC_VAR_NAME
• nvflare.fuel.f3.comm_error module
  • CommError
    • CommError.BAD_CONFIG
    • CommError.BAD_DATA
    • CommError.CLOSED
    • CommError.ERROR
    • CommError.NOT_READY
    • CommError.NOT_SUPPORTED
    • CommError.TIMEOUT
• nvflare.fuel.f3.communicator module
  • Communicator
    • Communicator.add_connector()
    • Communicator.add_connector_advanced()
    • Communicator.find_endpoint()
    • Communicator.register_message_receiver()
    • Communicator.register_monitor()
    • Communicator.remove_connector()
    • Communicator.remove_endpoint()
    • Communicator.send()
    • Communicator.start()
    • Communicator.start_listener()
    • Communicator.stop()
  • load_comm_drivers()
• nvflare.fuel.f3.connection module
  • ConnState
    • ConnState.CLOSED
    • ConnState.CONNECTED
    • ConnState.IDLE
  • Connection
    • Connection.close()
    • Connection.get_conn_properties()
    • Connection.process_frame()
    • Connection.register_frame_receiver()
    • Connection.send_frame()
  • FrameReceiver
    • FrameReceiver.process_frame()
  • create_connection_name()
• nvflare.fuel.f3.endpoint module
  • Endpoint
    • Endpoint.get_prop()
    • Endpoint.set_prop()
  • EndpointMonitor
    • EndpointMonitor.state_change()
  • EndpointState
    • EndpointState.CLOSING
    • EndpointState.DISCONNECTED
    • EndpointState.ERROR
    • EndpointState.IDLE
    • EndpointState.READY
• nvflare.fuel.f3.message module
  • AppIds
    • AppIds.ALL
    • AppIds.CELL_NET
    • AppIds.DEFAULT
    • AppIds.PUB_SUB
  • Message
    • Message.add_headers()
    • Message.get_header()
    • Message.get_prop()
    • Message.remove_header()
    • Message.set_header()
    • Message.set_prop()
  • MessageReceiver
    • MessageReceiver.process_message()
• nvflare.fuel.f3.mpm module
  • MainProcessMonitor
    • MainProcessMonitor.add_cleanup_cb()
    • MainProcessMonitor.get_aio_context()
    • MainProcessMonitor.is_stopping()
    • MainProcessMonitor.logger()
    • MainProcessMonitor.name
    • MainProcessMonitor.run()
    • MainProcessMonitor.set_name()
• nvflare.fuel.f3.stats_pool module
  • CounterPool
    • CounterPool.from_dict()
    • CounterPool.get_table()
    • CounterPool.increment()
    • CounterPool.to_dict()
  • CsvRecordHandler
    • CsvRecordHandler.close()
    • CsvRecordHandler.read_records()
    • CsvRecordHandler.write()
  • CsvRecordReader
  • HistPool
    • HistPool.from_dict()
    • HistPool.get_table()
    • HistPool.record_value()
    • HistPool.to_dict()
  • RecordWriter
    • RecordWriter.close()
    • RecordWriter.write()
  • StatsMode
    • StatsMode.AVERAGE
    • StatsMode.COUNT
    • StatsMode.MAX
    • StatsMode.MIN
    • StatsMode.PERCENT
  • StatsPool
    • StatsPool.from_dict()
    • StatsPool.get_table()
    • StatsPool.to_dict()
  • StatsPoolManager
    • StatsPoolManager.add_counter_pool()
    • StatsPoolManager.add_msg_size_pool()
    • StatsPoolManager.add_time_hist_pool()
    • StatsPoolManager.close()
    • StatsPoolManager.delete_pool()
    • StatsPoolManager.dump_summary()
    • StatsPoolManager.from_dict()
    • StatsPoolManager.get_pool()
    • StatsPoolManager.get_table()
    • StatsPoolManager.lock
    • StatsPoolManager.pool_config
    • StatsPoolManager.pools
    • StatsPoolManager.record_writer
    • StatsPoolManager.set_pool_config()
    • StatsPoolManager.set_record_writer()
    • StatsPoolManager.to_dict()
  • StatsRecord
  • format_value()
  • new_message_size_pool()
  • new_time_pool()
  • parse_hist_mode()
• nvflare.fuel.f3.stream_cell module
  • StreamCell
    • StreamCell.get_chunk_size()
    • StreamCell.register_blob_cb()
    • StreamCell.register_file_cb()
    • StreamCell.register_objects_cb()
    • StreamCell.register_stream_cb()
    • StreamCell.send_blob()
    • StreamCell.send_file()
    • StreamCell.send_objects()
    • StreamCell.send_stream()

Module contents