roc::pipeline::ReceiverEndpoint Class Reference

Receiver endpoint sub-pipeline. More...

#include <receiver_endpoint.h>

Inheritance diagram for roc::pipeline::ReceiverEndpoint:

Public Member Functions
	ReceiverEndpoint (address::Protocol proto, ReceiverState &receiver_state, ReceiverSessionGroup &session_group, const rtp::FormatMap &format_map, core::IArena &arena)
	Initialize.
bool	is_valid () const
	Check if the port pipeline was succefully constructed.
address::Protocol	proto () const
	Get protocol.
packet::IWriter &	writer ()
	Get endpoint writer.
ROC_ATTR_NODISCARD status::StatusCode	pull_packets ()
	Pull packets writter to endpoint writer.
Public Member Functions inherited from roc::core::RefCounted< ReceiverEndpoint, core::ArenaAllocation >
	RefCounted ()
	Initialize.
	RefCounted (const core::ArenaAllocation &policy)
	Initialize.
int	getref () const
	Get reference counter.
void	incref () const
	Increment reference counter.
void	decref () const
	Decrement reference counter.
Public Member Functions inherited from roc::core::ListNode
ListNodeData *	list_node_data () const
	Get list node data.

Additional Inherited Members
Protected Member Functions inherited from roc::core::ArenaAllocation
IArena &	arena () const
	Get arena.
	ArenaAllocation (IArena &arena)
	Initialize.
template<class T >
void	destroy (T &object)
	Destroy object and return memory to arena.

Detailed Description

Receiver endpoint sub-pipeline.

Contains:

• a pipeline for processing packets from single network endpoint
• a reference to session group to which packets are routed

Definition at line 39 of file receiver_endpoint.h.

Constructor & Destructor Documentation

ReceiverEndpoint()

roc::pipeline::ReceiverEndpoint::ReceiverEndpoint	(	address::Protocol	proto,
		ReceiverState &	receiver_state,
		ReceiverSessionGroup &	session_group,
		const rtp::FormatMap &	format_map,
		core::IArena &	arena )

Initialize.

• writer to handle packets received on netio thread.

Member Function Documentation

is_valid()

bool roc::pipeline::ReceiverEndpoint::is_valid

(

)

const

Check if the port pipeline was succefully constructed.

proto()

address::Protocol roc::pipeline::ReceiverEndpoint::proto

(

)

const

Get protocol.

pull_packets()

ROC_ATTR_NODISCARD status::StatusCode roc::pipeline::ReceiverEndpoint::pull_packets

(

)

Pull packets writter to endpoint writer.

writer()

packet::IWriter & roc::pipeline::ReceiverEndpoint::writer

(

)

Get endpoint writer.

Remarks

Packets passed to this writer will be pulled by endpoint pipeline. This writer is thread-safe and lock-free. The writer is passed to netio thread.

---

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

• roc_pipeline/receiver_endpoint.h