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< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >:

Collaboration diagram for ACE_Buffered_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >:

Public Member Functions
	ACE_Buffered_Svc_Handler (ACE_Thread_Manager thr_mgr=0, ACE_Message_Queue< ACE_SYNCH_USE > 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 (void)
	Destructor, which calls <flush>.

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

virtual int	flush (void)

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

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

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

virtual	~ACE_Svc_Handler (void)
	Destructor.

virtual int	open (void *=0)

virtual int	close (u_long flags=0)

virtual int	idle (u_long flags=0)

virtual ACE_Recyclable_State	recycle_state (void) 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 (void)

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 (void) const
	Get the underlying handle associated with the <peer_>.

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

ACE_PEER_STREAM &	peer (void) const

void *	operator new (size_t n)

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

virtual void	destroy (void)

void	operator delete (void *)

void	operator delete (void , void )

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

void	dump (void) 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 (void) const
	Get the recycler.

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

virtual int	recycle (void *=0)

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

virtual	~ACE_Task (void)
	Destructor.

ACE_Message_Queue < ACE_SYNCH_USE, ACE_System_Time_Policy > *	msg_queue (void)
	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 (void) const

void	set_time_policy (ACE_System_Time_Policyconst &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 (void) const

ACE_Task< ACE_SYNCH_USE, ACE_System_Time_Policy > *	next (void)
	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 (void)

ACE_Module< ACE_SYNCH_USE, ACE_System_Time_Policy > *	module (void) const
	Return the Task's Module if there is one, else returns 0.

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 (void) 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 (void)
	Destructor.

virtual int	module_closed (void)

virtual int	svc (void)
	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 (void)
	Wait for all threads running in a task to exit.

virtual int	suspend (void)
	Suspend a task.

virtual int	resume (void)
	Resume a suspended task.

int	grp_id (void) const
	Get the current group id.

void	grp_id (int)
	Set the current group id.

ACE_Thread_Manager *	thr_mgr (void) 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 (void) const
	True if queue is a reader, else false.

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

size_t	thr_count (void) const

ACE_thread_t	last_thread (void) const

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

virtual	~ACE_Service_Object (void)
	Destructor.

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

virtual int	priority (void) 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 (void)

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 (void) const
	Get the event demultiplexors.

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

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

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

Reference_Counting_Policy &	reference_counting_policy (void)
	Current Reference_Counting_Policy.

Public Member Functions inherited from ACE_Shared_Object
	ACE_Shared_Object (void)
	Constructor.

virtual	~ACE_Shared_Object (void)
	Destructor.

Protected Member Functions
virtual int	flush_i (void)

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< ACE_PEER_STREAM_2, ACE_SYNCH_USE >
ACE_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_

Additional Inherited Members
Public Types inherited from ACE_Svc_Handler< ACE_PEER_STREAM_2, ACE_SYNCH_USE >
typedef ACE_PEER_STREAM_ADDR	addr_type

typedef ACE_PEER_STREAM	stream_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)

Public Attributes inherited from ACE_Task< ACE_SYNCH_USE >
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.

Protected Types inherited from ACE_Event_Handler
typedef ACE_Atomic_Op < ACE_SYNCH_MUTEX, Reference_Count >	Atomic_Reference_Count
	Typedef for implementation of reference counting.

Detailed Description

template<ACE_PEER_STREAM_1, ACE_SYNCH_DECL>
class ACE_Buffered_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >

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.