ACE  6.3.3
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS > Class Template Reference

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 >:
Inheritance graph
[legend]
Collaboration diagram for ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >:
Collaboration graph
[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 (void)
 Destructor, which calls <flush>. More...
 
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. More...
 
- 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 (void)
 Destructor. More...
 
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 (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_>. More...
 
virtual void set_handle (ACE_HANDLE)
 Set the underlying handle associated with the <peer_>. More...
 
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. More...
 
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. More...
 
void dump (void) const
 Dump the state of an object. More...
 
virtual void recycler (ACE_Connection_Recycling_Strategy *recycler, const void *recycling_act)
 
virtual ACE_Connection_Recycling_Strategyrecycler (void) const
 Get the recycler. More...
 
virtual const void * recycling_act (void) const
 Get the recycling act. More...
 
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 (void)
 Destructor. More...
 
ACE_Message_Queue< ACE_SYNCH_USE, ACE_System_Time_Policy > * msg_queue (void)
 Gets the message queue associated with this task. More...
 
void msg_queue (ACE_Message_Queue< ACE_SYNCH_USE, ACE_System_Time_Policy > *)
 Sets the message queue associated with this task. More...
 
ACE_Time_Value_T< ACE_System_Time_Policygettimeofday (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_TCHARname (void) const
 
ACE_Task< ACE_SYNCH_USE, ACE_System_Time_Policy > * next (void)
 Get next Task pointer. More...
 
void next (ACE_Task< ACE_SYNCH_USE, ACE_System_Time_Policy > *)
 Set next Task pointer. More...
 
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. More...
 
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. More...
 
void dump (void) const
 Dump the state of an object. More...
 
- Public Member Functions inherited from ACE_Task_Base
 ACE_Task_Base (ACE_Thread_Manager *=0)
 Constructor. More...
 
virtual ~ACE_Task_Base (void)
 Destructor. More...
 
virtual int module_closed (void)
 
virtual int svc (void)
 Run by a daemon thread to handle deferred processing. More...
 
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. More...
 
virtual int suspend (void)
 Suspend a task. More...
 
virtual int resume (void)
 Resume a suspended task. More...
 
int grp_id (void) const
 Get the current group id. More...
 
void grp_id (int)
 Set the current group id. More...
 
ACE_Thread_Managerthr_mgr (void) const
 Get the thread manager associated with this Task. More...
 
void thr_mgr (ACE_Thread_Manager *)
 Set the thread manager associated with this Task. More...
 
int is_reader (void) const
 True if queue is a reader, else false. More...
 
int is_writer (void) const
 True if queue is a writer, else false. More...
 
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. More...
 
virtual ~ACE_Service_Object (void)
 Destructor. More...
 
- Public Member Functions inherited from ACE_Event_Handler
virtual ~ACE_Event_Handler (void)
 Destructor is virtual to enable proper cleanup. More...
 
virtual int priority (void) const
 
virtual void priority (int priority)
 Set the priority of the Event_Handler. More...
 
virtual int handle_input (ACE_HANDLE fd=ACE_INVALID_HANDLE)
 Called when input events occur (e.g., connection or data). More...
 
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). More...
 
virtual int handle_exit (ACE_Process *)
 Called when a process exits. More...
 
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. More...
 
virtual ACE_Reactorreactor (void) const
 Get the event demultiplexors. More...
 
virtual ACE_Reactor_Timer_Interfacereactor_timer_interface (void) const
 Get only the reactor's timer related interface. More...
 
virtual Reference_Count add_reference (void)
 Increment reference count on the handler. More...
 
virtual Reference_Count remove_reference (void)
 Decrement reference count on the handler. More...
 
Reference_Counting_Policyreference_counting_policy (void)
 Current Reference_Counting_Policy. More...
 
- Public Member Functions inherited from ACE_Shared_Object
 ACE_Shared_Object (void)
 Constructor. More...
 
virtual ~ACE_Shared_Object (void)
 Destructor. More...
 

Protected Member Functions

virtual int flush_i (void)
 
- Protected Member Functions inherited from ACE_Event_Handler
 ACE_Event_Handler (ACE_Reactor *=0, int priority=ACE_Event_Handler::LO_PRIORITY)
 Force ACE_Event_Handler to be an abstract base class. More...
 

Protected Attributes

size_t maximum_buffer_size_
 
size_t current_buffer_size_
 Current size in bytes of the <Message_Queue> contents. More...
 
ACE_Time_Value next_timeout_
 Timeout value used to control when the buffer is flushed. More...
 
ACE_Time_Value interval_
 Interval of the timeout. More...
 
ACE_Time_Valuetimeoutp_
 Timeout pointer. More...
 
- Protected Attributes inherited from ACE_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >
PEER_STREAM peer_
 Maintain connection with client. More...
 
bool dynamic_
 Have we been dynamically created? More...
 
bool closing_
 
ACE_Connection_Recycling_Strategyrecycler_
 Pointer to the connection recycler. More...
 
const void * recycling_act_
 
- Protected Attributes inherited from ACE_Task_Base
size_t thr_count_
 
ACE_Thread_Managerthr_mgr_
 Multi-threading manager. More...
 
u_long flags_
 ACE_Task flags. More...
 
int grp_id_
 This maintains the group id of the Task. More...
 
ACE_thread_t last_thread_id_
 Holds the thread ID of the last thread to exit svc() in this object. More...
 
- Protected Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count reference_count_
 Reference count. More...
 

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. More...
 
- 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. More...
 
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. More...
 
- 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.. More...
 
bool delete_msg_queue_
 true if should delete Message_Queue, false otherwise. More...
 
ACE_Module< ACE_SYNCH_USE, ACE_System_Time_Policy > * mod_
 Back-pointer to the enclosing module. More...
 
ACE_Task< ACE_SYNCH_USE, ACE_System_Time_Policy > * next_
 Pointer to adjacent ACE_Task. More...
 
 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 
- Protected Types inherited from ACE_Event_Handler
typedef ACE_Atomic_Op< ACE_SYNCH_MUTEX, Reference_CountAtomic_Reference_Count
 Typedef for implementation of reference counting. More...
 

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

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>.

template<typename PEER_STREAM , typename SYNCH_TRAITS >
ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::~ACE_Buffered_Svc_Handler ( void  )
virtual

Destructor, which calls <flush>.

Member Function Documentation

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

Dump the state of an object.

template<typename PEER_STREAM , typename SYNCH_TRAITS >
int ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::flush ( void  )
virtual

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

template<typename PEER_STREAM , typename SYNCH_TRAITS >
int ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::flush_i ( void  )
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.

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 >.

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

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.

template<typename PEER_STREAM , typename SYNCH_TRAITS >
ACE_Time_Value ACE_Buffered_Svc_Handler< PEER_STREAM, SYNCH_TRAITS >::interval_
protected

Interval of the timeout.

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.

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.

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: