Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Loading...
Searching...
No Matches
roc::pipeline::SenderEndpoint Class Reference

Sender endpoint sub-pipeline. More...

#include <sender_endpoint.h>

Inheritance diagram for roc::pipeline::SenderEndpoint:
roc::core::NonCopyable< T > roc::packet::IWriter

Public Member Functions

 SenderEndpoint (address::Protocol proto, core::IAllocator &allocator)
 Initialize.
 
bool valid () const
 Check if pipeline was succefully constructed.
 
address::Protocol proto () const
 Get protocol.
 
packet::IComposercomposer ()
 Get packet composer.
 
packet::IWriterwriter ()
 Get packet writer.
 
bool has_destination_writer () const
 Check if destination writer was set.
 
void set_destination_writer (packet::IWriter &writer)
 Set destination writer.
 
void set_destination_address (const address::SocketAddr &)
 Set destination address.
 

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,
core::IAllocator allocator 
)

Initialize.

Member Function Documentation

◆ composer()

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

Get packet composer.

Remarks
This composer will creates packets according to endpoint protocol.

◆ has_destination_writer()

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

Check if destination writer was set.

Remarks
True if set_destination_writer() was called.

◆ proto()

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

Get protocol.

◆ set_destination_address()

void roc::pipeline::SenderEndpoint::set_destination_address ( const address::SocketAddr )

Set destination address.

Remarks
When packets are written to the endpoint pipeline, they are assigned the specified destination address.

◆ set_destination_writer()

void roc::pipeline::SenderEndpoint::set_destination_writer ( packet::IWriter writer)

Set destination writer.

Remarks
When packets are written to the endpoint pipeline, in the end they go to the destination writer.

◆ valid()

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

Check if pipeline was succefully constructed.

◆ 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: