nvflare.fuel.f3.streaming package

Subpackages

• nvflare.fuel.f3.streaming.tools package
  • Submodules
    • nvflare.fuel.f3.streaming.tools.receiver module
      • create_receiver_cell()
      • receive_blob()
      • request_cb()
    • nvflare.fuel.f3.streaming.tools.sender module
      • cell_connected()
      • create_sender_cell()
      • send_blob()
    • nvflare.fuel.f3.streaming.tools.utils module
      • make_buffer()
      • setup_log()
  • Module contents

Submodules

• nvflare.fuel.f3.streaming.blob_streamer module
  • BlobHandler
    • BlobHandler.handle_blob_cb()
  • BlobStream
    • BlobStream.buffer_len()
    • BlobStream.read()
  • BlobStreamer
    • BlobStreamer.register_blob_callback()
    • BlobStreamer.send()
  • BlobTask
• nvflare.fuel.f3.streaming.byte_receiver module
  • ByteReceiver
    • ByteReceiver.received_stream_counter_pool
    • ByteReceiver.received_stream_size_pool
    • ByteReceiver.register_callback()
  • RxStream
    • RxStream.close()
    • RxStream.read()
  • RxTask
    • RxTask.find_or_create_task()
    • RxTask.map_lock
    • RxTask.process_chunk()
    • RxTask.read()
    • RxTask.rx_task_map
    • RxTask.stop()
• nvflare.fuel.f3.streaming.byte_streamer module
  • ByteStreamer
    • ByteStreamer.get_chunk_size()
    • ByteStreamer.map_lock
    • ByteStreamer.send()
    • ByteStreamer.sent_stream_counter_pool
    • ByteStreamer.sent_stream_size_pool
    • ByteStreamer.tx_task_map
  • ReliableRetryScheduler
    • ReliableRetryScheduler.register()
    • ReliableRetryScheduler.shutdown()
    • ReliableRetryScheduler.unregister()
    • ReliableRetryScheduler.wakeup()
  • TxTask
    • TxTask.cancel()
    • TxTask.handle_ack()
    • TxTask.remove_task()
    • TxTask.retry_task()
    • TxTask.send_loop()
    • TxTask.send_pending_buffer()
    • TxTask.start_task_thread()
    • TxTask.stop()
• nvflare.fuel.f3.streaming.cacheable module
  • CacheableObject
    • CacheableObject.clear_cache()
    • CacheableObject.downloaded_to_all()
    • CacheableObject.get_item_count()
    • CacheableObject.produce()
    • CacheableObject.produce_item()
    • CacheableObject.release()
    • CacheableObject.set_transaction()
    • CacheableObject.transaction_done()
  • ItemConsumer
    • ItemConsumer.consume()
    • ItemConsumer.consume_items()
    • ItemConsumer.download_completed()
    • ItemConsumer.download_failed()
• nvflare.fuel.f3.streaming.download_service module
  • Consumer
    • Consumer.consume()
    • Consumer.download_completed()
    • Consumer.download_failed()
  • DownloadService
    • DownloadService.FINISHED_REFS_TTL
    • DownloadService.TX_OUTCOME_TTL
    • DownloadService.add_object()
    • DownloadService.delete_transaction()
    • DownloadService.get_acquired_receivers()
    • DownloadService.get_transaction_id()
    • DownloadService.get_transaction_info()
    • DownloadService.get_transaction_outcome()
    • DownloadService.get_transfer_waiter()
    • DownloadService.new_transaction()
    • DownloadService.shutdown()
  • Downloadable
    • Downloadable.downloaded_to_all()
    • Downloadable.downloaded_to_one()
    • Downloadable.produce()
    • Downloadable.release()
    • Downloadable.set_transaction()
    • Downloadable.transaction_done()
  • OBJ_DOWNLOADER_TOPIC
  • ProduceRC
    • ProduceRC.EOF
    • ProduceRC.ERROR
    • ProduceRC.OK
  • TransactionInfo
  • TransferWaiter
    • TransferWaiter.acquired_receivers()
    • TransferWaiter.done()
    • TransferWaiter.outcome
    • TransferWaiter.wait()
  • download_object()
• nvflare.fuel.f3.streaming.file_downloader module
  • DEFAULT_CHUNK_SIZE
  • FileDownloadable
    • FileDownloadable.downloaded_to_all()
    • FileDownloadable.downloaded_to_one()
    • FileDownloadable.produce()
  • add_file()
  • download_file()
• nvflare.fuel.f3.streaming.obj_downloader module
  • ObjectDownloader
    • ObjectDownloader.add_object()
    • ObjectDownloader.delete_transaction()
    • ObjectDownloader.get_waiter()
• nvflare.fuel.f3.streaming.stream_const module
  • StreamDataType
    • StreamDataType.ACK
    • StreamDataType.CHUNK
    • StreamDataType.ERROR
    • StreamDataType.FINAL
    • StreamDataType.RESUME
    • StreamDataType.RESUME_ACK
  • StreamHeaderKey
    • StreamHeaderKey.CHANNEL
    • StreamHeaderKey.DATA_TYPE
    • StreamHeaderKey.ERROR_MSG
    • StreamHeaderKey.FILE_NAME
    • StreamHeaderKey.OBJECT_INDEX
    • StreamHeaderKey.OBJECT_STREAM_ID
    • StreamHeaderKey.OFFSET
    • StreamHeaderKey.OPTIONAL
    • StreamHeaderKey.PAYLOAD_ENCODING
    • StreamHeaderKey.RELIABLE
    • StreamHeaderKey.RETRY_TIMEOUT
    • StreamHeaderKey.RETRY_WAIT
    • StreamHeaderKey.SEQUENCE
    • StreamHeaderKey.SIZE
    • StreamHeaderKey.STREAM_ID
    • StreamHeaderKey.STREAM_REQ_ID
    • StreamHeaderKey.TOPIC
• nvflare.fuel.f3.streaming.stream_types module
  • Stream
    • Stream.close()
    • Stream.get_headers()
    • Stream.get_pos()
    • Stream.get_size()
    • Stream.read()
    • Stream.seek()
  • StreamCancelled
  • StreamError
  • StreamFuture
    • StreamFuture.add_done_callback()
    • StreamFuture.cancel()
    • StreamFuture.cancelled()
    • StreamFuture.done()
    • StreamFuture.exception()
    • StreamFuture.get_headers()
    • StreamFuture.get_progress()
    • StreamFuture.get_size()
    • StreamFuture.get_stream_id()
    • StreamFuture.result()
    • StreamFuture.running()
    • StreamFuture.set_exception()
    • StreamFuture.set_progress()
    • StreamFuture.set_result()
    • StreamFuture.set_size()
  • StreamTaskSpec
    • StreamTaskSpec.cancel()
• nvflare.fuel.f3.streaming.stream_utils module
  • CheckedExecutor
    • CheckedExecutor.shutdown()
    • CheckedExecutor.submit()
  • FastBuffer
    • FastBuffer.append()
    • FastBuffer.to_bytes()
  • gen_stream_id()
  • stream_shutdown()
  • stream_stats_category()
  • wrap_view()
• nvflare.fuel.f3.streaming.transfer_outcome module
  • DownloadStatus
    • DownloadStatus.FAILED
    • DownloadStatus.SUCCESS
  • RefOutcome
    • RefOutcome.receiver_statuses
    • RefOutcome.ref_id
  • TransactionDoneStatus
    • TransactionDoneStatus.DELETED
    • TransactionDoneStatus.FINISHED
    • TransactionDoneStatus.TIMEOUT
  • TransferOutcome
    • TransferOutcome.completed
    • TransferOutcome.done_status
    • TransferOutcome.expired()
    • TransferOutcome.min_receivers
    • TransferOutcome.num_receivers
    • TransferOutcome.quorum_met
    • TransferOutcome.reason
    • TransferOutcome.receiver_ids
    • TransferOutcome.refs
    • TransferOutcome.status
    • TransferOutcome.timestamp
    • TransferOutcome.tx_id
  • TransferOutcomeReason
    • TransferOutcomeReason.ALL_RECEIVERS_SUCCEEDED
    • TransferOutcomeReason.COMPUTATION_FAILED
    • TransferOutcomeReason.DELETED
    • TransferOutcomeReason.NO_OBJECTS
    • TransferOutcomeReason.RECEIVER_FAILED
    • TransferOutcomeReason.TIMEOUT
    • TransferOutcomeReason.UNKNOWN_DONE_STATUS
    • TransferOutcomeReason.UNKNOWN_RECEIVER_COUNT
  • compute_transfer_outcome()
  • terminal_state_for_done_status()
• nvflare.fuel.f3.streaming.transfer_progress module
  • StreamingProgressConfig
    • StreamingProgressConfig.streaming_idle_timeout
    • StreamingProgressConfig.streaming_max_peer_silence
  • TransferProgressRecord
    • TransferProgressRecord.bytes_done
    • TransferProgressRecord.direction
    • TransferProgressRecord.items_done
    • TransferProgressRecord.job_id
    • TransferProgressRecord.key
    • TransferProgressRecord.last_progress_time
    • TransferProgressRecord.receiver_id
    • TransferProgressRecord.sequence
    • TransferProgressRecord.started_time
    • TransferProgressRecord.state
    • TransferProgressRecord.task_id
    • TransferProgressRecord.terminal
    • TransferProgressRecord.transfer_id
    • TransferProgressRecord.transfer_id_kind
  • TransferProgressState
    • TransferProgressState.ABORTED
    • TransferProgressState.ACTIVE
    • TransferProgressState.COMPLETED
    • TransferProgressState.FAILED
    • TransferProgressState.TERMINAL_STATES
    • TransferProgressState.VALID_STATES
  • TransferProgressTracker
    • TransferProgressTracker.clear()
    • TransferProgressTracker.get_record()
    • TransferProgressTracker.is_stalled()
    • TransferProgressTracker.mark_terminal()
    • TransferProgressTracker.prune()
    • TransferProgressTracker.records()
    • TransferProgressTracker.remove()
    • TransferProgressTracker.set_idle_timeout()
    • TransferProgressTracker.stalled_records()
    • TransferProgressTracker.update()
  • TransferProgressUpdate
    • TransferProgressUpdate.accepted
    • TransferProgressUpdate.progressed
    • TransferProgressUpdate.reason
    • TransferProgressUpdate.record
  • check_positive_finite_number()
  • resolve_streaming_progress_config()

Module contents