spead2
v3.1.3
Introduction to spead2
Python API for spead2
C++ API for spead2
Performance tuning
Command-line tools
Migrating to version 3
Changelog
License
spead2
Docs
»
Index
Edit on GitHub
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
M
|
N
|
P
|
Q
|
R
|
S
|
U
|
V
|
W
Symbols
--count <count>
command line option
--direct-io
command line option
-C <cpu>
command line option
-D <cpu>
command line option
-N <cpu>
command line option
A
add_buffer_reader() (spead2.recv.Stream method)
add_descriptor() (spead2.send.Heap method)
add_end() (spead2.send.Heap method)
add_inproc_reader() (spead2.recv.Stream method)
add_item() (spead2.ItemGroup method)
(spead2.send.Heap method)
add_start() (spead2.send.Heap method)
add_tcp_reader() (spead2.recv.Stream method)
add_to_heap() (spead2.send.HeapGenerator method)
add_udp_ibv_reader() (spead2.recv.Stream method)
add_udp_pcap_file_reader() (spead2.recv.Stream method)
add_udp_reader() (spead2.recv.Stream method)
async_flush() (spead2.send.asyncio.AbstractStream method)
async_send_heap() (spead2.send.asyncio.AbstractStream method)
async_send_heaps() (spead2.send.asyncio.AbstractStream method)
AUTO (spead2.send.RateMethod attribute)
B
batches (spead2.recv.StreamStats attribute)
built-in function
spead2.recv.Heap.is_end_of_stream()
spead2.recv.Heap.is_start_of_stream()
spead2.recv.IncompleteHeap.is_end_of_stream()
spead2.recv.IncompleteHeap.is_start_of_stream()
C
capacity() (spead2.recv.Stream.Ringbuffer method)
cnt (spead2.recv.Heap attribute)
(spead2.recv.IncompleteHeap attribute)
command line option
--count <count>
--direct-io
-C <cpu>
-D <cpu>
-N <cpu>
compatible_shape() (spead2.Descriptor method)
config (spead2.recv.Stream attribute)
D
Descriptor (class in spead2)
dynamic_shape() (spead2.Descriptor method)
E
environment variable
M_MMAP_THRESHOLD
PKG_CONFIG_PATH
SPEAD2_IBV_COMP_VECTOR
SPEAD2_IBV_INTERFACE
,
[1]
,
[2]
F
fd (spead2.recv.Stream attribute)
Flavour (built-in class)
flavour (spead2.recv.Heap attribute)
(spead2.recv.IncompleteHeap attribute)
flush() (spead2.send.asyncio.AbstractStream method)
G
get() (spead2.recv.asyncio.Stream method)
(spead2.recv.Stream method)
get_end() (spead2.send.HeapGenerator method)
get_heap() (spead2.send.HeapGenerator method)
get_nowait() (spead2.recv.Stream method)
get_start() (spead2.send.HeapGenerator method)
getvalue() (spead2.send.BytesStream method)
H
heap_length (spead2.recv.IncompleteHeap attribute)
HeapGenerator (class in spead2.send)
heaps (spead2.recv.StreamStats attribute)
HW (spead2.send.RateMethod attribute)
I
ids() (spead2.ItemGroup method)
incomplete_heaps_evicted (spead2.recv.StreamStats attribute)
incomplete_heaps_flushed (spead2.recv.StreamStats attribute)
InprocStream (class in spead2.send.asyncio)
is_variable_size() (spead2.Descriptor method)
Item (class in spead2)
ItemGroup (class in spead2)
items() (spead2.ItemGroup method)
itemsize_bits (spead2.Descriptor attribute)
K
keys() (spead2.ItemGroup method)
M
M_MMAP_THRESHOLD
max_batch (spead2.recv.StreamStats attribute)
module
spead2
N
num_substreams (spead2.send.AbstractStream attribute)
P
packets (spead2.recv.StreamStats attribute)
payload_ranges (spead2.recv.IncompleteHeap attribute)
PKG_CONFIG_PATH
Q
queues (spead2.send.InprocStream attribute)
R
received_length (spead2.recv.IncompleteHeap attribute)
recv::spead2::packet_memcpy_function (C++ type)
repeat_pointers (spead2.send.Heap attribute)
ring_config (spead2.recv.Stream attribute)
ringbuffer (spead2.recv.Stream attribute)
ROUND_ROBIN (spead2.send.GroupMode attribute)
S
search_dist (spead2.recv.StreamStats attribute)
send::spead2::group_mode (C++ enum)
send::spead2::group_mode::ROUND_ROBIN (C++ enumerator)
send_heap() (spead2.send.AbstractStream method)
send_heaps() (spead2.send.AbstractStream method)
set_affinity() (spead2.spead2.ThreadPool static method)
set_cnt_sequence() (spead2.send.AbstractStream method)
single_packet_heaps (spead2.recv.StreamStats attribute)
size() (spead2.recv.Stream.Ringbuffer method)
spead2
module
spead2.InprocQueue (built-in class)
spead2.MemoryPool (built-in class)
spead2.MmapAllocator (built-in class)
spead2.recv.asyncio.Stream (built-in class)
spead2.recv.Heap (built-in class)
spead2.recv.Heap.is_end_of_stream()
built-in function
spead2.recv.Heap.is_start_of_stream()
built-in function
spead2.recv.IncompleteHeap (built-in class)
spead2.recv.IncompleteHeap.is_end_of_stream()
built-in function
spead2.recv.IncompleteHeap.is_start_of_stream()
built-in function
spead2.recv.RingStreamConfig (built-in class)
spead2.recv.Stream (built-in class)
spead2.recv.Stream.Ringbuffer (built-in class)
spead2.recv.StreamConfig (built-in class)
spead2.recv.StreamStats (built-in class)
spead2.recv.UdpIbvConfig (built-in class)
spead2.send.AbstractStream (built-in class)
spead2.send.asyncio.AbstractStream (built-in class)
spead2.send.BytesStream (built-in class)
spead2.send.GroupMode (built-in class)
spead2.send.Heap (built-in class)
spead2.send.HeapReference (built-in class)
spead2.send.InprocStream (built-in class)
spead2.send.RateMethod (built-in class)
spead2.send.StreamConfig (built-in class)
spead2.send.TcpStream (built-in class)
spead2.send.UdpIbvConfig (built-in class)
spead2.send.UdpIbvStream (built-in class)
spead2.send.UdpStream (built-in class)
spead2.ThreadPool (class in spead2)
spead2::descriptor (C++ struct)
spead2::descriptor::description (C++ member)
spead2::descriptor::format (C++ member)
spead2::descriptor::id (C++ member)
spead2::descriptor::name (C++ member)
spead2::descriptor::numpy_header (C++ member)
spead2::descriptor::shape (C++ member)
spead2::inproc_queue (C++ class)
spead2::inproc_queue::stop (C++ function)
spead2::io_service_ref (C++ class)
spead2::io_service_ref::get_shared_thread_pool (C++ function)
,
[1]
spead2::io_service_ref::io_service_ref (C++ function)
,
[1]
,
[2]
spead2::io_service_ref::operator* (C++ function)
spead2::io_service_ref::operator-> (C++ function)
spead2::memory_allocator (C++ class)
spead2::memory_allocator::allocate (C++ function)
spead2::memory_allocator::free (C++ function)
spead2::recv::heap (C++ class)
spead2::recv::heap::get_cnt (C++ function)
spead2::recv::heap::get_descriptors (C++ function)
spead2::recv::heap::get_flavour (C++ function)
spead2::recv::heap::get_items (C++ function)
spead2::recv::heap::heap (C++ function)
spead2::recv::heap::is_ctrl_item (C++ function)
spead2::recv::heap::is_end_of_stream (C++ function)
spead2::recv::heap::is_start_of_stream (C++ function)
spead2::recv::heap::to_descriptor (C++ function)
spead2::recv::incomplete_heap (C++ class)
spead2::recv::incomplete_heap::get_cnt (C++ function)
spead2::recv::incomplete_heap::get_flavour (C++ function)
spead2::recv::incomplete_heap::get_heap_length (C++ function)
spead2::recv::incomplete_heap::get_items (C++ function)
spead2::recv::incomplete_heap::get_payload (C++ function)
spead2::recv::incomplete_heap::get_payload_ranges (C++ function)
spead2::recv::incomplete_heap::get_received_length (C++ function)
spead2::recv::incomplete_heap::incomplete_heap (C++ function)
spead2::recv::incomplete_heap::is_ctrl_item (C++ function)
spead2::recv::incomplete_heap::is_end_of_stream (C++ function)
spead2::recv::incomplete_heap::is_start_of_stream (C++ function)
spead2::recv::inproc_reader (C++ class)
spead2::recv::inproc_reader::inproc_reader (C++ function)
spead2::recv::item (C++ struct)
spead2::recv::item::id (C++ member)
spead2::recv::item::immediate_value (C++ member)
spead2::recv::item::is_immediate (C++ member)
spead2::recv::item::length (C++ member)
spead2::recv::item::ptr (C++ member)
spead2::recv::live_heap (C++ class)
spead2::recv::live_heap::get_bug_compat (C++ function)
spead2::recv::live_heap::get_cnt (C++ function)
spead2::recv::live_heap::is_complete (C++ function)
spead2::recv::live_heap::is_contiguous (C++ function)
spead2::recv::live_heap::is_end_of_stream (C++ function)
spead2::recv::mem_reader (C++ class)
spead2::recv::ring_stream (C++ class)
spead2::recv::ring_stream::get_ring_config (C++ function)
spead2::recv::ring_stream::pop (C++ function)
spead2::recv::ring_stream::pop_live (C++ function)
spead2::recv::ring_stream::ring_stream (C++ function)
spead2::recv::ring_stream::try_pop (C++ function)
spead2::recv::ring_stream::try_pop_live (C++ function)
spead2::recv::ring_stream_config (C++ class)
spead2::recv::ring_stream_config::get_contiguous_only (C++ function)
spead2::recv::ring_stream_config::get_heaps (C++ function)
spead2::recv::ring_stream_config::set_contiguous_only (C++ function)
spead2::recv::ring_stream_config::set_heaps (C++ function)
spead2::recv::stream (C++ class)
spead2::recv::stream::emplace_reader (C++ function)
spead2::recv::stream::flush (C++ function)
spead2::recv::stream::get_config (C++ function)
spead2::recv::stream::get_stats (C++ function)
spead2::recv::stream::stop (C++ function)
spead2::recv::stream_config (C++ class)
spead2::recv::stream_config::get_allow_out_of_order (C++ function)
spead2::recv::stream_config::get_allow_unsized_heaps (C++ function)
spead2::recv::stream_config::get_bug_compat (C++ function)
spead2::recv::stream_config::get_max_heaps (C++ function)
spead2::recv::stream_config::get_memcpy (C++ function)
spead2::recv::stream_config::get_memory_allocator (C++ function)
spead2::recv::stream_config::get_stop_on_stop_item (C++ function)
spead2::recv::stream_config::set_allow_out_of_order (C++ function)
spead2::recv::stream_config::set_allow_unsized_heaps (C++ function)
spead2::recv::stream_config::set_bug_compat (C++ function)
spead2::recv::stream_config::set_max_heaps (C++ function)
spead2::recv::stream_config::set_memcpy (C++ function)
,
[1]
,
[2]
spead2::recv::stream_config::set_memory_allocator (C++ function)
spead2::recv::stream_config::set_stop_on_stop_item (C++ function)
spead2::recv::stream_stats (C++ struct)
spead2::recv::stream_stats::batches (C++ member)
spead2::recv::stream_stats::heaps (C++ member)
spead2::recv::stream_stats::incomplete_heaps_evicted (C++ member)
spead2::recv::stream_stats::incomplete_heaps_flushed (C++ member)
spead2::recv::stream_stats::max_batch (C++ member)
spead2::recv::stream_stats::packets (C++ member)
spead2::recv::stream_stats::search_dist (C++ member)
spead2::recv::stream_stats::single_packet_heaps (C++ member)
spead2::recv::stream_stats::worker_blocked (C++ member)
spead2::recv::tcp_reader (C++ class)
spead2::recv::tcp_reader::tcp_reader (C++ function)
,
[1]
,
[2]
spead2::recv::udp_ibv_config (C++ class)
spead2::recv::udp_ibv_config::add_endpoint (C++ function)
spead2::recv::udp_ibv_config::default_buffer_size (C++ member)
spead2::recv::udp_ibv_config::default_max_poll (C++ member)
spead2::recv::udp_ibv_config::default_max_size (C++ member)
spead2::recv::udp_ibv_config::get_buffer_size (C++ function)
spead2::recv::udp_ibv_config::get_comp_vector (C++ function)
spead2::recv::udp_ibv_config::get_endpoints (C++ function)
spead2::recv::udp_ibv_config::get_interface_address (C++ function)
spead2::recv::udp_ibv_config::get_max_poll (C++ function)
spead2::recv::udp_ibv_config::get_max_size (C++ function)
spead2::recv::udp_ibv_config::set_buffer_size (C++ function)
spead2::recv::udp_ibv_config::set_comp_vector (C++ function)
spead2::recv::udp_ibv_config::set_endpoints (C++ function)
spead2::recv::udp_ibv_config::set_interface_address (C++ function)
spead2::recv::udp_ibv_config::set_max_poll (C++ function)
spead2::recv::udp_ibv_config::set_max_size (C++ function)
spead2::recv::udp_ibv_reader (C++ class)
spead2::recv::udp_ibv_reader::udp_ibv_reader (C++ function)
,
[1]
,
[2]
spead2::recv::udp_pcap_file_reader (C++ class)
spead2::recv::udp_pcap_file_reader::udp_pcap_file_reader (C++ function)
spead2::recv::udp_reader (C++ class)
spead2::recv::udp_reader::udp_reader (C++ function)
,
[1]
,
[2]
,
[3]
spead2::send::heap (C++ class)
spead2::send::heap::add_descriptor (C++ function)
spead2::send::heap::add_end (C++ function)
spead2::send::heap::add_item (C++ function)
spead2::send::heap::add_pointer (C++ function)
spead2::send::heap::add_start (C++ function)
spead2::send::heap::get_flavour (C++ function)
spead2::send::heap::get_item (C++ function)
,
[1]
spead2::send::heap::get_repeat_pointers (C++ function)
spead2::send::heap::heap (C++ function)
spead2::send::heap::item_handle (C++ type)
spead2::send::heap::set_repeat_pointers (C++ function)
spead2::send::heap_reference (C++ struct)
spead2::send::heap_reference::cnt (C++ member)
spead2::send::heap_reference::heap (C++ member)
spead2::send::heap_reference::heap_reference (C++ function)
spead2::send::heap_reference::substream_index (C++ member)
spead2::send::inproc_stream (C++ class)
spead2::send::inproc_stream::get_queue (C++ function)
spead2::send::inproc_stream::inproc_stream (C++ function)
,
[1]
spead2::send::item (C++ struct)
spead2::send::item::allow_immediate (C++ member)
spead2::send::item::id (C++ member)
spead2::send::item::immediate (C++ member)
spead2::send::item::is_inline (C++ member)
spead2::send::item::item (C++ function)
,
[1]
,
[2]
,
[3]
,
[4]
spead2::send::item::length (C++ member)
spead2::send::item::ptr (C++ member)
spead2::send::stream (C++ class)
spead2::send::stream::async_send_heap (C++ function)
spead2::send::stream::async_send_heaps (C++ function)
spead2::send::stream::completion_handler (C++ type)
spead2::send::stream::flush (C++ function)
spead2::send::stream::get_io_service (C++ function)
spead2::send::stream::get_num_substreams (C++ function)
spead2::send::stream::set_cnt_sequence (C++ function)
spead2::send::stream_config (C++ class)
spead2::send::stream_config::get_burst_rate (C++ function)
spead2::send::stream_config::get_burst_rate_ratio (C++ function)
spead2::send::stream_config::get_burst_size (C++ function)
spead2::send::stream_config::get_max_heaps (C++ function)
spead2::send::stream_config::get_max_packet_size (C++ function)
spead2::send::stream_config::get_rate (C++ function)
spead2::send::stream_config::get_rate_method (C++ function)
spead2::send::stream_config::set_burst_rate_ratio (C++ function)
spead2::send::stream_config::set_burst_size (C++ function)
spead2::send::stream_config::set_max_heaps (C++ function)
spead2::send::stream_config::set_max_packet_size (C++ function)
spead2::send::stream_config::set_rate (C++ function)
spead2::send::stream_config::set_rate_method (C++ function)
spead2::send::streambuf_stream (C++ class)
spead2::send::streambuf_stream::streambuf_stream (C++ function)
spead2::send::tcp_stream (C++ class)
spead2::send::tcp_stream::tcp_stream (C++ function)
,
[1]
,
[2]
spead2::send::udp_ibv_config (C++ class)
spead2::send::udp_ibv_config::add_endpoint (C++ function)
spead2::send::udp_ibv_config::add_memory_region (C++ function)
spead2::send::udp_ibv_config::default_buffer_size (C++ member)
spead2::send::udp_ibv_config::default_max_poll (C++ member)
spead2::send::udp_ibv_config::get_buffer_size (C++ function)
spead2::send::udp_ibv_config::get_comp_vector (C++ function)
spead2::send::udp_ibv_config::get_endpoints (C++ function)
spead2::send::udp_ibv_config::get_interface_address (C++ function)
spead2::send::udp_ibv_config::get_max_poll (C++ function)
spead2::send::udp_ibv_config::get_memory_regions (C++ function)
spead2::send::udp_ibv_config::get_ttl (C++ function)
spead2::send::udp_ibv_config::set_buffer_size (C++ function)
spead2::send::udp_ibv_config::set_comp_vector (C++ function)
spead2::send::udp_ibv_config::set_endpoints (C++ function)
spead2::send::udp_ibv_config::set_interface_address (C++ function)
spead2::send::udp_ibv_config::set_max_poll (C++ function)
spead2::send::udp_ibv_config::set_memory_regions (C++ function)
spead2::send::udp_ibv_config::set_ttl (C++ function)
spead2::send::udp_ibv_stream (C++ class)
spead2::send::udp_ibv_stream::udp_ibv_stream (C++ function)
,
[1]
spead2::send::udp_stream (C++ class)
spead2::send::udp_stream::udp_stream (C++ function)
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
,
[6]
,
[7]
spead2::set_log_function (C++ function)
spead2::thread_pool (C++ class)
spead2::thread_pool::get_io_service (C++ function)
spead2::thread_pool::set_affinity (C++ function)
spead2::thread_pool::stop (C++ function)
spead2::thread_pool::thread_pool (C++ function)
SPEAD2_IBV_COMP_VECTOR
SPEAD2_IBV_INTERFACE
,
[1]
,
[2]
SPEAD2_MAJOR (C macro)
SPEAD2_MINOR (C macro)
SPEAD2_PATCH (C macro)
SPEAD2_VERSION (C macro)
stats (spead2.recv.Stream attribute)
stop() (spead2.InprocQueue method)
(spead2.recv.Stream method)
(spead2.spead2.ThreadPool method)
SW (spead2.send.RateMethod attribute)
U
update() (spead2.ItemGroup method)
V
value (spead2.Item attribute)
values() (spead2.ItemGroup method)
version (spead2.Item attribute)
W
warn_on_empty (spead2.MemoryPool attribute)
worker_blocked (spead2.recv.StreamStats attribute)
Read the Docs
v: v3.1.3
Versions
latest
stable
v3.1.3
v3.1.2
v3.1.1
v3.1.0
v3.0.1
v3.0.0
v2.1.2
v2.1.1
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
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.