roc::ctl::BasicControlEndpoint Class Reference

Base class for control endpoints. More...

#include <roc_ctl/basic_control_endpoint.h>

Inheritance diagram for roc::ctl::BasicControlEndpoint:

Public Member Functions
	BasicControlEndpoint (core::IArena &)
	Initialization.
virtual bool	is_bound () const =0
	Check if endpoint is successfully bound to local URI.
virtual bool	is_connected () const =0
	Check if endpoint is successfully connected to remote URI.
virtual bool	async_bind (const address::EndpointUri &uri, ControlTask &notify_task)=0
	Initiate asynchronous binding to local URI. On completion, resumes notify_task.
virtual bool	async_connect (const address::EndpointUri &uri, ControlTask &notify_task)=0
	Initiate asynchronous connecting to remote URI. Should be called after successfull bind. On completion, resumes notify_task.
virtual void	async_close (ControlTask &notify_task)=0
	Initiate asynchronous closing of endpoint. On completion, resumes notify_task.
virtual bool	attach_sink (const address::EndpointUri &uri, pipeline::SenderLoop &sink)=0
	Add sink pipeline controlled by this endpoint. Should be called after successfull bind.
virtual bool	detach_sink (pipeline::SenderLoop &sink)=0
	Remove sink pipeline. Should be called for earlier attached sink.
virtual bool	attach_source (const address::EndpointUri &uri, pipeline::ReceiverLoop &source)=0
	Add source pipeline controlled by this endpoint. Should be called after successfull bind.
virtual bool	detach_source (pipeline::ReceiverLoop &source)=0
	Remove source pipeline. Should be called for earlier attached source.
Public Member Functions inherited from roc::core::RefCounted< BasicControlEndpoint, 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< Tag >
ListData *	list_data () const
	Get pointer to internal data.

Additional Inherited Members
Static Public Member Functions inherited from roc::core::ListNode< Tag >
static ListNode *	list_node (ListData *data)
	Get pointer to parent node from pointer to internal data.
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

Base class for control endpoints.

Definition at line 26 of file basic_control_endpoint.h.

Constructor & Destructor Documentation

BasicControlEndpoint()

roc::ctl::BasicControlEndpoint::BasicControlEndpoint

(

core::IArena &

)

Initialization.

Member Function Documentation

async_bind()

virtual bool roc::ctl::BasicControlEndpoint::async_bind ( const address::EndpointUri &  uri, ControlTask &  notify_task  )

pure virtual

Initiate asynchronous binding to local URI. On completion, resumes notify_task.

async_close()

virtual void roc::ctl::BasicControlEndpoint::async_close ( ControlTask &  notify_task )

pure virtual

Initiate asynchronous closing of endpoint. On completion, resumes notify_task.

async_connect()

virtual bool roc::ctl::BasicControlEndpoint::async_connect ( const address::EndpointUri &  uri, ControlTask &  notify_task  )

pure virtual

Initiate asynchronous connecting to remote URI. Should be called after successfull bind. On completion, resumes notify_task.

attach_sink()

virtual bool roc::ctl::BasicControlEndpoint::attach_sink ( const address::EndpointUri &  uri, pipeline::SenderLoop &  sink  )

pure virtual

Add sink pipeline controlled by this endpoint. Should be called after successfull bind.

attach_source()

virtual bool roc::ctl::BasicControlEndpoint::attach_source ( const address::EndpointUri &  uri, pipeline::ReceiverLoop &  source  )

pure virtual

Add source pipeline controlled by this endpoint. Should be called after successfull bind.

detach_sink()

virtual bool roc::ctl::BasicControlEndpoint::detach_sink ( pipeline::SenderLoop &  sink )

pure virtual

Remove sink pipeline. Should be called for earlier attached sink.

detach_source()

virtual bool roc::ctl::BasicControlEndpoint::detach_source ( pipeline::ReceiverLoop &  source )

pure virtual

Remove source pipeline. Should be called for earlier attached source.

is_bound()

virtual bool roc::ctl::BasicControlEndpoint::is_bound ( ) const

pure virtual

Check if endpoint is successfully bound to local URI.

is_connected()

virtual bool roc::ctl::BasicControlEndpoint::is_connected ( ) const

pure virtual

Check if endpoint is successfully connected to remote URI.

---

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

• roc_ctl/basic_control_endpoint.h