roc::ctl::BasicControlEndpoint Class Reference

Base class for control endpoints. More...

#include <basic_control_endpoint.h>

Inheritance diagram for roc::ctl::BasicControlEndpoint:

Public Member Functions
	BasicControlEndpoint (core::IAllocator &)
	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::StandardAllocation >
	RefCounted ()
	Initialization with default allocation policy.
	RefCounted (const core::StandardAllocation &policy)
	Initialization with arbitrary allocation policy.
long	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::StandardAllocation
IAllocator &	allocator () const
	Get allocator.
	StandardAllocation ()
	Initialize in invalid state. Such instance wont be usable.
	StandardAllocation (IAllocator &allocator)
	Initialize with given allocator. Such instance will use allocator to destroy objects.
template<class T >
void	destroy (T &object)
	Destroy object and deallocate its memory.

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::IAllocator &

)

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