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)
 Set task parameters. More...
 
packet::IWriterget_writer () const
 Get packet writer 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
MpscQueueDatampsc_queue_data () const
 Get list node data. More...
 

Additional Inherited Members

- Protected Attributes inherited from roc::pipeline::ReceiverLoop::Task
bool(ReceiverLoop::* func_ )(Task &)
 Task implementation method. More...
 
ReceiverSlotslot_
 Slot. More...
 
address::Interface iface_
 Interface. More...
 
address::Protocol proto_
 Protocol. More...
 
packet::IWriterwriter_
 Packet writer. More...
 
ReceiverSlotMetricsslot_metrics_
 Output for slot metrics. More...
 
ReceiverSessionMetricssess_metrics_
 Output for session metrics. More...
 
size_t * sess_metrics_size_
 Input/output session metrics size. More...
 

Detailed Description

Create endpoint on given interface of the slot.

Definition at line 103 of file receiver_loop.h.

Constructor & Destructor Documentation

◆ AddEndpoint()

roc::pipeline::ReceiverLoop::Tasks::AddEndpoint::AddEndpoint ( SlotHandle  slot,
address::Interface  iface,
address::Protocol  proto 
)

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_writer()

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

Get packet writer for the endpoint.

Remarks
The returned writer may be used from any thread.

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