spead2
latest
  • Introduction to spead2
  • Python API for spead2
  • C++ API for spead2
  • Advanced features
  • Performance tuning
  • Command-line tools
  • Migrating to version 3
  • Changelog
  • License
spead2
  • »
  • Welcome to spead2’s documentation!
  • Edit on GitHub

Welcome to spead2’s documentation!¶

Contents:

  • Introduction to spead2
    • Preparation
    • Installing spead2 for Python
    • Installing spead2 for C++
  • Python API for spead2
    • SPEAD flavours
    • Mapping of SPEAD protocol to Python
    • Stream control items
    • Items and item groups
    • Thread pools
    • Receiving
    • Sending
    • In-process transport
    • Logging
    • Support for ibverbs
    • Chunking receiver
  • C++ API for spead2
    • C++ API stability
    • Asynchronous I/O
    • Receiving
    • Sending
    • In-process transport
    • Logging
    • Support for ibverbs
    • Chunking receiver
  • Advanced features
    • Chunking receiver
    • Receiver stream statistics
  • Performance tuning
    • System tuning
    • Protocol design
    • Application tuning
  • Command-line tools
    • spead2_bench
    • spead2_send/spead2_recv
    • mcdump
    • spead2_net_raw
  • Migrating to version 3
    • Receive stream configuration
    • Send stream configuration
    • Substreams
    • Out-of-order packets
    • Loop argument to asyncio functions
    • Command-line arguments in tools
    • Removal of deprecated functionality
    • Queue depth for sending with ibverbs
  • Changelog
  • License

Indices and tables¶

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2015–2021, National Research Foundation (SARAO). Revision 7f2ac25e.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
v3.10.0
v3.9.1
v3.8.0
v3.7.0
v3.6.0
v3.5.0
v3.4.0
v3.3.2
v3.3.0
v3.2.2
v3.1.3
v3.0.1
v2.1.2
v2.0.2
v1.14.0
v1.13.1
v1.12.0
v1.11.4
v1.10.1
v1.9.2
v1.8.0
v1.7.2
v1.6.0
v1.5.2
v1.4.0
v1.3.2
v1.2.2
v1.1.2
v1.0.1
Downloads
pdf
On Read the Docs
Project Home
Builds