Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::pipeline::SenderEndpoint Class Reference

Sender endpoint sub-pipeline. More...

#include <sender_endpoint.h>

Inheritance diagram for roc::pipeline::SenderEndpoint:
Collaboration diagram for roc::pipeline::SenderEndpoint:

Public Member Functions

 SenderEndpoint (address::Protocol proto, const address::SocketAddr &dest_address, packet::IWriter &dest_writer, core::IArena &arena)
 Initialize. More...
 
bool is_valid () const
 Check if pipeline was succefully constructed. More...
 
address::Protocol proto () const
 Get protocol. More...
 
packet::IComposercomposer ()
 Get packet composer. More...
 
packet::IWriterwriter ()
 Get packet writer. More...
 

Detailed Description

Sender endpoint sub-pipeline.

Contains:

  • a pipeline for processing packets for single network endpoint

Definition at line 33 of file sender_endpoint.h.

Constructor & Destructor Documentation

◆ SenderEndpoint()

roc::pipeline::SenderEndpoint::SenderEndpoint ( address::Protocol  proto,
const address::SocketAddr dest_address,
packet::IWriter dest_writer,
core::IArena arena 
)

Initialize.

  • dest_address specifies destination address that is assigned to the outgoing packets in the end of endpoint pipeline
  • dest_writer specifies destination writer to which packets are sent in the end of endpoint pipeline

Member Function Documentation

◆ composer()

packet::IComposer& roc::pipeline::SenderEndpoint::composer ( )

Get packet composer.

Remarks
This composer will creates packets according to endpoint protocol.

◆ is_valid()

bool roc::pipeline::SenderEndpoint::is_valid ( ) const

Check if pipeline was succefully constructed.

◆ proto()

address::Protocol roc::pipeline::SenderEndpoint::proto ( ) const

Get protocol.

◆ writer()

packet::IWriter& roc::pipeline::SenderEndpoint::writer ( )

Get packet writer.

Remarks
This writer will pass packets to the endpoint pipeline.

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