#include <sender.h>

Inheritance diagram for roc::node::Sender:

[legend]

Collaboration diagram for roc::node::Sender:

[legend]

Public Types
typedef uint64_t	slot_index_t
	Slot index. More...

typedef void(*	slot_metrics_func_t) (const pipeline::SenderSlotMetrics &slot_metrics, void *slot_arg)
	Callback for slot metrics. More...

typedef void(*	party_metrics_func_t) (const pipeline::SenderParticipantMetrics &party_metrics, size_t party_index, void *party_arg)
	Callback for participant metrics. More...

Public Member Functions
	Sender (Context &context, const pipeline::SenderSinkConfig &pipeline_config)
	Initialize. More...

	~Sender ()
	Deinitialize. More...

bool	is_valid () const
	Check if successfully constructed. More...

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

ROC_ATTR_NODISCARD bool	connect (slot_index_t slot_index, address::Interface iface, const address::EndpointUri &uri)
	Connect to remote endpoint. More...

ROC_ATTR_NODISCARD bool	unlink (slot_index_t slot_index)
	Remove slot. More...

ROC_ATTR_NODISCARD bool	get_metrics (slot_index_t slot_index, slot_metrics_func_t slot_metrics_func, void slot_metrics_arg, party_metrics_func_t party_metrics_func, size_t party_metrics_size, void *party_metrics_arg)
	Get metrics. More...

bool	has_incomplete ()
	Check if there are incomplete or broken slots. More...

bool	has_broken ()
	Check if there are broken slots. More...

sndio::ISink &	sink ()
	Get sender sink. More...

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

virtual	~Node ()
	Deinitialize. More...

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

Detailed Description

Sender node.

Definition at line 35 of file sender.h.

Member Typedef Documentation

◆ party_metrics_func_t

typedef void(* roc::node::Sender::party_metrics_func_t) (const pipeline::SenderParticipantMetrics &party_metrics, size_t party_index, void *party_arg)

Callback for participant metrics.

Definition at line 67 of file sender.h.

◆ slot_index_t

typedef uint64_t roc::node::Sender::slot_index_t

Slot index.

Definition at line 38 of file sender.h.

◆ slot_metrics_func_t

typedef void(* roc::node::Sender::slot_metrics_func_t) (const pipeline::SenderSlotMetrics &slot_metrics, void *slot_arg)

Callback for slot metrics.

Definition at line 63 of file sender.h.

Constructor & Destructor Documentation

◆ Sender()

roc::node::Sender::Sender	(	Context &	context,
		const pipeline::SenderSinkConfig &	pipeline_config
	)

Initialize.

◆ ~Sender()

roc::node::Sender::~Sender ( )

Deinitialize.

Member Function Documentation

◆ configure()

ROC_ATTR_NODISCARD bool roc::node::Sender::configure	(	slot_index_t	slot_index,
		address::Interface	iface,
		const netio::UdpConfig &	config
	)

Set interface config.

◆ connect()

ROC_ATTR_NODISCARD bool roc::node::Sender::connect	(	slot_index_t	slot_index,
		address::Interface	iface,
		const address::EndpointUri &	uri
	)

Connect to remote endpoint.

◆ get_metrics()

ROC_ATTR_NODISCARD bool roc::node::Sender::get_metrics	(	slot_index_t	slot_index,
		slot_metrics_func_t	slot_metrics_func,
		void *	slot_metrics_arg,
		party_metrics_func_t	party_metrics_func,
		size_t *	party_metrics_size,
		void *	party_metrics_arg
	)

Get metrics.

◆ has_broken()

bool roc::node::Sender::has_broken ( )

Check if there are broken slots.

◆ has_incomplete()

bool roc::node::Sender::has_incomplete ( )

Check if there are incomplete or broken slots.

◆ is_valid()

bool roc::node::Sender::is_valid ( ) const

Check if successfully constructed.

◆ sink()

sndio::ISink& roc::node::Sender::sink ( )

Get sender sink.

◆ unlink()

ROC_ATTR_NODISCARD bool roc::node::Sender::unlink ( slot_index_t slot_index )

Remove slot.

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

roc_node/sender.h

Public Types

Public Member Functions