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

Receiver session pipeline. More...

#include <receiver_session.h>

Inheritance diagram for roc::pipeline::ReceiverSession:
Collaboration diagram for roc::pipeline::ReceiverSession:

Public Member Functions

 ReceiverSession (const ReceiverSessionConfig &session_config, const ReceiverCommonConfig &common_config, const packet::Address &src_address, const fec::CodecMap &codec_map, const rtp::FormatMap &format_map, packet::PacketPool &packet_pool, core::BufferPool< uint8_t > &byte_buffer_pool, core::BufferPool< audio::sample_t > &sample_buffer_pool, core::IAllocator &allocator)
 Initialize. More...
 
bool valid () const
 Check if the session pipeline was succefully constructed. More...
 
bool handle (const packet::PacketPtr &packet)
 Try to route a packet to this session. More...
 
bool update (packet::timestamp_t time)
 Update session. More...
 
audio::IReaderreader ()
 Get audio reader. More...
 
- Public Member Functions inherited from roc::core::RefCnt< ReceiverSession >
long getref () const
 Get reference counter. More...
 
void incref () const
 Increment reference counter. More...
 
void decref () const
 Decrement reference counter. More...
 
- Public Member Functions inherited from roc::core::ListNode
ListNodeDatalist_node_data () const
 Get list node data. More...
 

Friends

class core::RefCnt< ReceiverSession >
 

Detailed Description

Receiver session pipeline.

Remarks
Created at the receiver side for every connected sender.

Definition at line 49 of file receiver_session.h.

Constructor & Destructor Documentation

roc::pipeline::ReceiverSession::ReceiverSession ( const ReceiverSessionConfig session_config,
const ReceiverCommonConfig common_config,
const packet::Address src_address,
const fec::CodecMap codec_map,
const rtp::FormatMap format_map,
packet::PacketPool packet_pool,
core::BufferPool< uint8_t > &  byte_buffer_pool,
core::BufferPool< audio::sample_t > &  sample_buffer_pool,
core::IAllocator allocator 
)

Initialize.

Member Function Documentation

bool roc::pipeline::ReceiverSession::handle ( const packet::PacketPtr packet)

Try to route a packet to this session.

Returns
true if the packet is dedicated for this session
audio::IReader& roc::pipeline::ReceiverSession::reader ( )

Get audio reader.

bool roc::pipeline::ReceiverSession::update ( packet::timestamp_t  time)

Update session.

Returns
false if the session is terminated
bool roc::pipeline::ReceiverSession::valid ( ) const

Check if the session pipeline was succefully constructed.


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