#include <receiver.h>

Inheritance diagram for roc::node::Receiver:

Public Types
typedef uint64_t	slot_index_t
	Slot index.

typedef void(*	sess_metrics_func_t) (const pipeline::ReceiverSessionMetrics &sess_metrics, size_t sess_index, void *sess_arg)
	Callback for getting session metrics.

Public Member Functions
	Receiver (Context &context, const pipeline::ReceiverConfig &pipeline_config)
	Initialize.

	~Receiver ()
	Deinitialize.

bool	is_valid ()
	Check if successfully constructed.

bool	configure (slot_index_t slot_index, address::Interface iface, const netio::UdpReceiverConfig &config)
	Set interface config.

bool	bind (slot_index_t slot_index, address::Interface iface, address::EndpointUri &uri)
	Bind to local endpoint.

bool	unlink (slot_index_t slot_index)
	Remove slot.

bool	get_metrics (slot_index_t slot_index, pipeline::ReceiverSlotMetrics &slot_metrics, sess_metrics_func_t sess_metrics_func, size_t sess_metrics_size, void sess_metrics_arg)
	Get slot metrics.

bool	has_broken ()
	Check if there are broken slots.

sndio::ISource &	source ()
	Get receiver source.

Public Member Functions inherited from roc::node::Node
	Node (Context &context)
	Initialize.

virtual	~Node ()
	Deinitialize.

Context &	context ()
	All nodes hold reference to context.

Detailed Description

Receiver node.

Definition at line 33 of file receiver.h.

Member Typedef Documentation

◆ sess_metrics_func_t

typedef void(* roc::node::Receiver::sess_metrics_func_t) (const pipeline::ReceiverSessionMetrics &sess_metrics, size_t sess_index, void *sess_arg)

Callback for getting session metrics.

Definition at line 60 of file receiver.h.

◆ slot_index_t

typedef uint64_t roc::node::Receiver::slot_index_t

Slot index.

Definition at line 36 of file receiver.h.

Constructor & Destructor Documentation

◆ Receiver()

roc::node::Receiver::Receiver	(	Context &	context,
		const pipeline::ReceiverConfig &	pipeline_config )

Initialize.

◆ ~Receiver()

roc::node::Receiver::~Receiver ( )

Deinitialize.

Member Function Documentation

◆ bind()

bool roc::node::Receiver::bind	(	slot_index_t	slot_index,
		address::Interface	iface,
		address::EndpointUri &	uri )

Bind to local endpoint.

◆ configure()

bool roc::node::Receiver::configure	(	slot_index_t	slot_index,
		address::Interface	iface,
		const netio::UdpReceiverConfig &	config )

Set interface config.

◆ get_metrics()

bool roc::node::Receiver::get_metrics	(	slot_index_t	slot_index,
		pipeline::ReceiverSlotMetrics &	slot_metrics,
		sess_metrics_func_t	sess_metrics_func,
		size_t *	sess_metrics_size,
		void *	sess_metrics_arg )

Get slot metrics.

Remarks: Metrics for slot are written into slot_metrics. Metrics for each session are passed to sess_metrics_func.

◆ has_broken()

bool roc::node::Receiver::has_broken ( )

Check if there are broken slots.

◆ is_valid()

bool roc::node::Receiver::is_valid ( )

Check if successfully constructed.

◆ source()

sndio::ISource & roc::node::Receiver::source ( )

Get receiver source.

◆ unlink()

bool roc::node::Receiver::unlink ( slot_index_t slot_index )

Remove slot.

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

roc_node/receiver.h

Public Types

Public Member Functions