Python API for spead2

This documentation does not cover all the classes and methods in the module. Instead, it documents those that are expected to be commonly used by the user, and omits those designed for the classes to communicate with each other or with the C++ backend.

• SPEAD flavours
  • Flavour
• Mapping of SPEAD protocol to Python
• Stream control items
• Items and item groups
  • Descriptor
  • Item
  • ItemGroup
• Thread pools
  • spead2.ThreadPool
• Receiving
  • spead2.recv.Heap
  • Configuration
  • Blocking receive
  • Asynchronous receive
  • Packet ordering
  • Memory allocators
  • Incomplete Heaps
  • Statistics
  • Explicit start
• Sending
  • spead2.send.StreamConfig
  • spead2.send.RateMethod
  • HeapGenerator
  • spead2.send.Heap
  • Substreams
  • Blocking send
  • Asynchronous send
  • Batching
• In-process transport
  • Sending
  • Receiving
• Logging
• Support for ibverbs
  • System configuration
  • Receiving
  • Sending
• Chunking receiver
  • Writing a place callback
  • Reference
• Chunking stream groups
  • spead2.recv.ChunkStreamGroupConfig
  • spead2.recv.ChunkStreamRingGroup
  • spead2.recv.ChunkStreamGroupMember