Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::pipeline::ReceiverLoop::Tasks::AddEndpoint Class Reference

Create endpoint on given interface of the slot. More...

#include <receiver_loop.h>

Inheritance diagram for roc::pipeline::ReceiverLoop::Tasks::AddEndpoint:
Collaboration diagram for roc::pipeline::ReceiverLoop::Tasks::AddEndpoint:

Public Member Functions

 AddEndpoint (SlotHandle slot, address::Interface iface, address::Protocol proto, const address::SocketAddr &inbound_address, packet::IWriter *outbound_writer)
 Set task parameters. More...
 
packet::IWriterget_inbound_writer () const
 Get packet writer for inbound packets for the endpoint. More...
 
- Public Member Functions inherited from roc::pipeline::PipelineTask
bool success () const
 Check that the task finished and succeeded. More...
 
- Public Member Functions inherited from roc::core::MpscQueueNode< Tag >
MpscQueueDatampsc_queue_data () const
 Get pointer to internal data. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from roc::core::MpscQueueNode< Tag >
static MpscQueueNodempsc_queue_node (MpscQueueData *data)
 Get pointer to parent node from pointer to internal data. More...
 
- Protected Attributes inherited from roc::pipeline::ReceiverLoop::Task
bool(ReceiverLoop::* func_ )(Task &)
 Task implementation method. More...
 
ReceiverSlotslot_
 Slot. More...
 
ReceiverSlotConfig slot_config_
 Slot config. More...
 
address::Interface iface_
 Interface. More...
 
address::Protocol proto_
 Protocol. More...
 
address::SocketAddr inbound_address_
 Inbound packet address. More...
 
packet::IWriterinbound_writer_
 Inbound packet writer. More...
 
packet::IWriteroutbound_writer_
 Outbound packet writer. More...
 
ReceiverSlotMetricsslot_metrics_
 Output slot metrics. More...
 
ReceiverParticipantMetricsparty_metrics_
 Output participant metrics. More...
 
size_t * party_count_
 Input/output participant count. More...
 

Detailed Description

Create endpoint on given interface of the slot.

Definition at line 105 of file receiver_loop.h.

Constructor & Destructor Documentation

◆ AddEndpoint()

roc::pipeline::ReceiverLoop::Tasks::AddEndpoint::AddEndpoint ( SlotHandle  slot,
address::Interface  iface,
address::Protocol  proto,
const address::SocketAddr inbound_address,
packet::IWriter outbound_writer 
)

Set task parameters.

Remarks
Each slot can have one source and zero or one repair endpoint. The protocols of endpoints in one slot should be compatible.

Member Function Documentation

◆ get_inbound_writer()

packet::IWriter* roc::pipeline::ReceiverLoop::Tasks::AddEndpoint::get_inbound_writer ( ) const

Get packet writer for inbound packets for the endpoint.

Remarks
The returned writer may be used from any thread.

The documentation for this class was generated from the following file: