Defines the interface for a service that exchanges data with its connected peer and supports buffering. More...

#include <Svc_Handler.h>

Inheritance diagram for ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >:

[legend]

Collaboration diagram for ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >:

[legend]

Public Member Functions
	ACE_Buffered_Svc_Handler (ACE_Thread_Manager thr_mgr=0, ACE_Message_Queue< SYNCH_TRAITS > mq=0, ACE_Reactor reactor=ACE_Reactor::instance(), size_t max_buffer_size=0, ACE_Time_Value relative_timeout=0)

virtual	~ACE_Buffered_Svc_Handler ()
	Destructor, which calls <flush>.

virtual int	put (ACE_Message_Block message_block, ACE_Time_Value timeout=0)

virtual int	flush ()

virtual int	handle_timeout (const ACE_Time_Value &time, const void *)

void	dump () const
	Dump the state of an object.

Public Member Functions inherited from ACE_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >
	ACE_Svc_Handler (ACE_Thread_Manager thr_mgr=0, ACE_Message_Queue< SYNCH_TRAITS > mq=0, ACE_Reactor *reactor=ACE_Reactor::instance())

virtual	~ACE_Svc_Handler ()
	Destructor.

virtual int	open (void *acceptor_or_connector=0)

virtual int	close (u_long flags=0)

virtual int	idle (u_long flags=0)

virtual ACE_Recyclable_State	recycle_state () const

virtual int	recycle_state (ACE_Recyclable_State new_state)

virtual void	cleanup_hint (void **act_holder=0)

virtual int	init (int argc, ACE_TCHAR *argv[])

virtual int	fini ()

virtual int	info (ACE_TCHAR **info_string, size_t length) const

virtual int	handle_close (ACE_HANDLE=ACE_INVALID_HANDLE, ACE_Reactor_Mask=ACE_Event_Handler::ALL_EVENTS_MASK)

virtual ACE_HANDLE	get_handle () const
	Get the underlying handle associated with the <peer_>.

virtual void	set_handle (ACE_HANDLE)
	Set the underlying handle associated with the <peer_>.

PEER_STREAM &	peer () const

void *	operator new (size_t n)

void *	operator new (size_t n, const std::nothrow_t &) noexcept

void	operator delete (void *p, const std::nothrow_t &) noexcept

void *	operator new (size_t n, void *p)
	This operator permits "placement new" on a per-object basis.

virtual void	destroy ()

void	operator delete (void *)

void	operator delete (void , void )

void	shutdown ()
	Close down the descriptor and unregister from the Reactor.

void	dump () const
	Dump the state of an object.

virtual void	recycler (ACE_Connection_Recycling_Strategy recycler, const void recycling_act)

virtual ACE_Connection_Recycling_Strategy *	recycler () const
	Get the recycler.

virtual const void *	recycling_act () const
	Get the recycling act.

virtual int	recycle (void *=0)

Public Member Functions inherited from ACE_Task< SYNCH_TRAITS >
	ACE_Task (ACE_Thread_Manager thr_mgr=0, ACE_Message_Queue< ACE_SYNCH_USE, ACE_System_Time_Policy > mq=0)

virtual	~ACE_Task ()
	Destructor.

ACE_Message_Queue< ACE_SYNCH_USE, ACE_System_Time_Policy > *	msg_queue ()
	Gets the message queue associated with this task.

void	msg_queue (ACE_Message_Queue< ACE_SYNCH_USE, ACE_System_Time_Policy > *)
	Sets the message queue associated with this task.

ACE_Time_Value_T< ACE_System_Time_Policy >	gettimeofday () const

void	set_time_policy (ACE_System_Time_Policy const &time_policy)

int	putq (ACE_Message_Block , ACE_Time_Value timeout=0)

int	getq (ACE_Message_Block &mb, ACE_Time_Value timeout=0)

int	ungetq (ACE_Message_Block , ACE_Time_Value timeout=0)

int	reply (ACE_Message_Block mb, ACE_Time_Value tv=0)

int	put_next (ACE_Message_Block msg, ACE_Time_Value timeout=0)

const ACE_TCHAR *	name () const

virtual ACE_Task< ACE_SYNCH_USE, ACE_System_Time_Policy > *	next ()
	Get next Task pointer.

void	next (ACE_Task< ACE_SYNCH_USE, ACE_System_Time_Policy > *)
	Set next Task pointer.

ACE_Task< ACE_SYNCH_USE, ACE_System_Time_Policy > *	sibling ()

virtual int	flush (u_long flag=ACE_Task_Flags::ACE_FLUSHALL)

void	water_marks (ACE_IO_Cntl_Msg::ACE_IO_Cntl_Cmds, size_t)
	Manipulate watermarks.

void	dump () const
	Dump the state of an object.

Public Member Functions inherited from ACE_Task_Base
	ACE_Task_Base (ACE_Thread_Manager *=0)
	Constructor.

virtual	~ACE_Task_Base ()
	Destructor.

virtual int	module_closed ()

virtual int	svc ()
	Run by a daemon thread to handle deferred processing.

virtual int	activate (long flags=THR_NEW_LWP\|THR_JOINABLE\|THR_INHERIT_SCHED, int n_threads=1, int force_active=0, long priority=ACE_DEFAULT_THREAD_PRIORITY, int grp_id=-1, ACE_Task_Base task=0, ACE_hthread_t thread_handles[]=0, void stack[]=0, size_t stack_size[]=0, ACE_thread_t thread_ids[]=0, const char *thr_name[]=0)

virtual int	wait ()
	Wait for all threads running in a task to exit.

virtual int	suspend ()
	Suspend a task.

virtual int	resume ()
	Resume a suspended task.

int	grp_id () const
	Get the current group id.

void	grp_id (int)
	Set the current group id.

ACE_Thread_Manager *	thr_mgr () const
	Get the thread manager associated with this Task.

void	thr_mgr (ACE_Thread_Manager *)
	Set the thread manager associated with this Task.

int	is_reader () const
	True if queue is a reader, else false.

int	is_writer () const
	True if queue is a writer, else false.

size_t	thr_count () const

ACE_thread_t	last_thread () const

Public Member Functions inherited from ACE_Service_Object
	ACE_Service_Object (ACE_Reactor *=0)
	Constructor.

virtual	~ACE_Service_Object ()
	Destructor.

Public Member Functions inherited from ACE_Event_Handler
virtual	~ACE_Event_Handler ()=default
	Destructor is virtual to enable proper cleanup.

virtual int	priority () const

virtual void	priority (int priority)
	Set the priority of the Event_Handler.

virtual int	handle_input (ACE_HANDLE fd=ACE_INVALID_HANDLE)
	Called when input events occur (e.g., connection or data).

virtual int	handle_output (ACE_HANDLE fd=ACE_INVALID_HANDLE)

virtual int	handle_exception (ACE_HANDLE fd=ACE_INVALID_HANDLE)
	Called when an exceptional events occur (e.g., SIGURG).

virtual int	handle_exit (ACE_Process *)
	Called when a process exits.

virtual int	handle_signal (int signum, siginfo_t =0, ucontext_t =0)

virtual int	resume_handler ()

virtual int	handle_qos (ACE_HANDLE=ACE_INVALID_HANDLE)

virtual int	handle_group_qos (ACE_HANDLE=ACE_INVALID_HANDLE)

virtual void	reactor (ACE_Reactor *reactor)
	Set the event demultiplexors.

virtual ACE_Reactor *	reactor () const
	Get the event demultiplexors.

virtual ACE_Reactor_Timer_Interface *	reactor_timer_interface () const
	Get only the reactor's timer related interface.

virtual Reference_Count	add_reference ()
	Increment reference count on the handler.

virtual Reference_Count	remove_reference ()
	Decrement reference count on the handler.

Reference_Counting_Policy &	reference_counting_policy ()
	Current Reference_Counting_Policy.

Public Member Functions inherited from ACE_Shared_Object
	ACE_Shared_Object ()
	Constructor.

virtual	~ACE_Shared_Object ()
	Destructor.

Protected Member Functions
virtual int	flush_i ()

Protected Member Functions inherited from ACE_Event_Handler
	ACE_Event_Handler (ACE_Reactor *=nullptr, int priority=ACE_Event_Handler::LO_PRIORITY)
	Force ACE_Event_Handler to be an abstract base class.

Protected Attributes
size_t	maximum_buffer_size_

size_t	current_buffer_size_
	Current size in bytes of the <Message_Queue> contents.

ACE_Time_Value	next_timeout_
	Timeout value used to control when the buffer is flushed.

ACE_Time_Value	interval_
	Interval of the timeout.

ACE_Time_Value *	timeoutp_
	Timeout pointer.

Protected Attributes inherited from ACE_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >
PEER_STREAM	peer_
	Maintain connection with client.

bool	dynamic_
	Have we been dynamically created?

bool	closing_

ACE_Connection_Recycling_Strategy *	recycler_
	Pointer to the connection recycler.

const void *	recycling_act_

Protected Attributes inherited from ACE_Task_Base
size_t	thr_count_

ACE_Thread_Manager *	thr_mgr_
	Multi-threading manager.

u_long	flags_
	ACE_Task flags.

int	grp_id_
	This maintains the group id of the Task.

ACE_thread_t	last_thread_id_
	Holds the thread ID of the last thread to exit svc() in this object.

Protected Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count	reference_count_
	Reference count.

Additional Inherited Members
Public Types inherited from ACE_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >
typedef PEER_STREAM::PEER_ADDR	addr_type

typedef PEER_STREAM	stream_type

Public Types inherited from ACE_Event_Handler
enum	{ LO_PRIORITY = 0 , HI_PRIORITY = 10 , NULL_MASK = 0 , READ_MASK = (1 << 0) , WRITE_MASK = (1 << 1) , EXCEPT_MASK = (1 << 2) , ACCEPT_MASK = (1 << 3) , CONNECT_MASK = (1 << 4) , TIMER_MASK = (1 << 5) , QOS_MASK = (1 << 6) , GROUP_QOS_MASK = (1 << 7) , SIGNAL_MASK = (1 << 8) , ALL_EVENTS_MASK , RWE_MASK , DONT_CALL = (1 << 9) }

enum	{ ACE_EVENT_HANDLER_NOT_RESUMED = -1 , ACE_REACTOR_RESUMES_HANDLER = 0 , ACE_APPLICATION_RESUMES_HANDLER }

typedef long	Reference_Count
	Reference count type.

Static Public Member Functions inherited from ACE_Task_Base
static ACE_THR_FUNC_RETURN	svc_run (void *)
	Routine that runs the service routine as a daemon thread.

static void	cleanup (void object, void params)

Static Public Member Functions inherited from ACE_Event_Handler
static ACE_THR_FUNC_RETURN	read_adapter (void *event_handler)

static int	register_stdin_handler (ACE_Event_Handler eh, ACE_Reactor reactor, ACE_Thread_Manager *thr_mgr, int flags=THR_DETACHED)

static int	remove_stdin_handler (ACE_Reactor reactor, ACE_Thread_Manager thr_mgr)
	Performs the inverse of the register_stdin_handler() method.

Public Attributes inherited from ACE_Task< SYNCH_TRAITS >
ACE_Message_Queue< ACE_SYNCH_USE, ACE_System_Time_Policy > *	msg_queue_
	Queue of messages on the ACE_Task..

bool	delete_msg_queue_
	true if should delete Message_Queue, false otherwise.

ACE_Module< ACE_SYNCH_USE, ACE_System_Time_Policy > *	mod_
	Back-pointer to the enclosing module.

ACE_Task< ACE_SYNCH_USE, ACE_System_Time_Policy > *	next_
	Pointer to adjacent ACE_Task.

	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.

Public Attributes inherited from ACE_Service_Object
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.

Protected Types inherited from ACE_Event_Handler
typedef std::atomic< Reference_Count >	Atomic_Reference_Count
	Typedef for implementation of reference counting.

Detailed Description

template<typename PEER_STREAM, typename SYNCH_TRAITS>
class ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >

Defines the interface for a service that exchanges data with its connected peer and supports buffering.

The buffering feature makes it possible to queue up ACE_Message_Blocks in an ACE_Message_Queue until (1) the queue is "full" or (2) a period of time elapses, at which point the queue is "flushed" via <sendv_n> to the peer.

Constructor & Destructor Documentation

◆ ACE_Buffered_Svc_Handler()

template<typename PEER_STREAM , typename SYNCH_TRAITS >

ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::ACE_Buffered_Svc_Handler	(	ACE_Thread_Manager *	thr_mgr = 0,
		ACE_Message_Queue< SYNCH_TRAITS > *	mq = 0,
		ACE_Reactor *	reactor = ACE_Reactor::instance (),
		size_t	max_buffer_size = 0,
		ACE_Time_Value *	relative_timeout = 0 )

Constructor initializes the thr_mgr and mq by passing them down to the ACE_Task base class. The reactor is passed to the ACE_Event_Handler. The max_buffer_size and relative_timeout are used to determine at what point to flush the mq. By default, there's no buffering at all. The relative_timeout value is interpreted to be in a unit that's relative to the current time returned by <ACE_OS::gettimeofday>.

◆ ~ACE_Buffered_Svc_Handler()

template<typename PEER_STREAM , typename SYNCH_TRAITS >

ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::~ACE_Buffered_Svc_Handler ( )

virtual

Destructor, which calls <flush>.

Member Function Documentation

◆ dump()

template<typename PEER_STREAM , typename SYNCH_TRAITS >

void ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::dump ( ) const

Dump the state of an object.

◆ flush()

template<typename PEER_STREAM , typename SYNCH_TRAITS >

int ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::flush ( )

virtual

Flush the ACE_Message_Queue, which writes all the queued ACE_Message_Blocks to the <PEER_STREAM>.

◆ flush_i()

template<typename PEER_STREAM , typename SYNCH_TRAITS >

int ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::flush_i ( )

protectedvirtual

Implement the flush operation on the ACE_Message_Queue, which writes all the queued ACE_Message_Blocks to the <PEER_STREAM>. Assumes that the caller holds the lock.

◆ handle_timeout()

template<typename PEER_STREAM , typename SYNCH_TRAITS >

int ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::handle_timeout	(	const ACE_Time_Value &	time,
		const void *	)

virtual

This method is not currently implemented – this is where the integration with the <Reactor> would occur.

Reimplemented from ACE_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >.

◆ put()

template<typename PEER_STREAM , typename SYNCH_TRAITS >

int ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::put	(	ACE_Message_Block *	message_block,
		ACE_Time_Value *	timeout = 0 )

virtual

Insert the ACE_Message_Block chain rooted at message_block into the ACE_Message_Queue with the designated timeout. The <flush> method will be called if this <put> causes the number of bytes to exceed the maximum buffer size or if the timeout period has elapsed.

Reimplemented from ACE_Task_Base.

Member Data Documentation

◆ current_buffer_size_

template<typename PEER_STREAM , typename SYNCH_TRAITS >

size_t ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::current_buffer_size_

protected

Current size in bytes of the <Message_Queue> contents.

◆ interval_

template<typename PEER_STREAM , typename SYNCH_TRAITS >

ACE_Time_Value ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::interval_

protected

Interval of the timeout.

◆ maximum_buffer_size_

template<typename PEER_STREAM , typename SYNCH_TRAITS >

size_t ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::maximum_buffer_size_

protected

Maximum size the <Message_Queue> can be before we have to flush the buffer.

◆ next_timeout_

template<typename PEER_STREAM , typename SYNCH_TRAITS >

ACE_Time_Value ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::next_timeout_

protected

Timeout value used to control when the buffer is flushed.

◆ timeoutp_

template<typename PEER_STREAM , typename SYNCH_TRAITS >

ACE_Time_Value* ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::timeoutp_

protected

Timeout pointer.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ACE_Buffered_Svc_Handler()

◆ ~ACE_Buffered_Svc_Handler()

Member Function Documentation

◆ dump()

◆ flush()

◆ flush_i()

◆ handle_timeout()

◆ put()

Member Data Documentation

◆ current_buffer_size_

◆ interval_

◆ maximum_buffer_size_

◆ next_timeout_

◆ timeoutp_