ACE  6.1.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL > Class Template Reference

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

#include <Svc_Handler.h>

Inheritance diagram for ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >:
Inheritance graph
[legend]
Collaboration diagram for ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >:
Collaboration graph
[legend]

Public Types

typedef ACE_PEER_STREAM_ADDR addr_type
 
typedef ACE_PEER_STREAM stream_type
 

Public Member Functions

 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 int handle_timeout (const ACE_Time_Value &time, const void *)
 
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_STREAMpeer (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_TCHARname (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 put (ACE_Message_Block *, ACE_Time_Value *=0)
 Default ACE_Task put routine.
 
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_Managerthr_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_Reactorreactor (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_Policyreference_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 Attributes

ACE_PEER_STREAM peer_
 Maintain connection with client.
 
bool dynamic_
 Have we been dynamically created?
 
bool closing_
 
ACE_Connection_Recycling_Strategyrecycler_
 Pointer to the connection recycler.
 
const void * recycling_act_
 

Additional Inherited Members

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

Detailed Description

template<ACE_PEER_STREAM_1, ACE_SYNCH_DECL>
class ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >

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

This class provides a well-defined interface that the Acceptor and Connector pattern factories use as their target. Typically, client applications will subclass ACE_Svc_Handler and do all the interesting work in the subclass. One thing that the ACE_Svc_Handler does contain is a PEER_STREAM endpoint that is initialized by an ACE_Acceptor or ACE_Connector when a connection is established successfully. This endpoint is used to exchange data between a ACE_Svc_Handler and the peer it is connected with.

Member Typedef Documentation

template<ACE_PEER_STREAM_1 , ACE_SYNCH_DECL >
typedef ACE_PEER_STREAM_ADDR ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >::addr_type
template<ACE_PEER_STREAM_1 , ACE_SYNCH_DECL >
typedef ACE_PEER_STREAM ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >::stream_type

Constructor & Destructor Documentation

template<PR_ST_1 , ACE_SYNCH_DECL >
ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::ACE_Svc_Handler ( ACE_Thread_Manager thr_mgr = 0,
ACE_Message_Queue< ACE_SYNCH_USE > *  mq = 0,
ACE_Reactor reactor = ACE_Reactor::instance () 
)

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.

template<PR_ST_1 , ACE_SYNCH_DECL >
ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::~ACE_Svc_Handler ( void  )
virtual

Destructor.

Member Function Documentation

template<PR_ST_1 , ACE_SYNCH_DECL >
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::cleanup_hint ( void **  act_holder = 0)
virtual

When the svc_handle is no longer needed around as a hint, call this method. In addition, reset *act_holder to zero if act_holder != 0.

template<PR_ST_1 , ACE_SYNCH_DECL >
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::close ( u_long  flags = 0)
virtual

Object termination hook – application-specific cleanup code goes here. This function is called by the idle() function if the object does not have a ACE_Connection_Recycling_Strategy associated with it. Also, due to this class's derivation from ACE_Task, close() is also called when a thread activated with this object exits. See ACE_Task::close() for further details. The default action of this function is to call handle_close() with the default arguments.

Reimplemented from ACE_Task_Base.

template<PR_ST_1 , ACE_SYNCH_DECL >
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::destroy ( void  )
virtual

Call this to free up dynamically allocated <Svc_Handlers> (otherwise you will get memory leaks). In general, you should call this method rather than <delete> since this method knows whether or not the object was allocated dynamically, and can act accordingly (i.e., deleting it if it was allocated dynamically).

template<PR_ST_1 , ACE_SYNCH_DECL >
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::dump ( void  ) const

Dump the state of an object.

template<PR_ST_1 , ACE_SYNCH_DECL >
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::fini ( void  )
virtual

Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.

Reimplemented from ACE_Shared_Object.

template<PR_ST_1 , ACE_SYNCH_DECL >
ACE_HANDLE ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::get_handle ( void  ) const
virtual

Get the underlying handle associated with the <peer_>.

Reimplemented from ACE_Event_Handler.

template<PR_ST_1 , ACE_SYNCH_DECL >
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::handle_close ( ACE_HANDLE  = ACE_INVALID_HANDLE,
ACE_Reactor_Mask  = ACE_Event_Handler::ALL_EVENTS_MASK 
)
virtual

Perform termination activities on the SVC_HANDLER. The default behavior is to close down the <peer_> (to avoid descriptor leaks) and to <destroy> this object (to avoid memory leaks)! If you don't want this behavior make sure you override this method...

Reimplemented from ACE_Event_Handler.

template<PR_ST_1 , ACE_SYNCH_DECL >
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::handle_timeout ( const ACE_Time_Value time,
const void *   
)
virtual

Default behavior when timeouts occur is to close down the <Svc_Handler> by calling <handle_close>.

Reimplemented from ACE_Event_Handler.

Reimplemented in ACE_Buffered_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >.

template<PR_ST_1 , ACE_SYNCH_DECL >
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::idle ( u_long  flags = 0)
virtual

Call this method if you want to recycling the Svc_Handler instead of closing it. If the object does not have a recycler, it will be closed.

template<PR_ST_1 , ACE_SYNCH_DECL >
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::info ( ACE_TCHAR **  info_string,
size_t  length 
) const
virtual

Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.

Reimplemented from ACE_Shared_Object.

template<PR_ST_1 , ACE_SYNCH_DECL >
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::init ( int  argc,
ACE_TCHAR argv[] 
)
virtual

Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.

Reimplemented from ACE_Shared_Object.

template<PR_ST_1 , ACE_SYNCH_DECL >
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::open ( void *  = 0)
virtual

Activate the client handler. This is typically called by the ACE_Acceptor or ACE_Connector.

Reimplemented from ACE_Task_Base.

template<PR_ST_1 , ACE_SYNCH_DECL >
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::operator delete ( void *  obj)

This really should be private so that users are forced to call <destroy>. Unfortunately, the C++ standard doesn't allow there to be a public new and a private delete. It is a bad idea to call this method directly, so use <destroy> instead, unless you know for sure that you've allocated the object dynamically.

template<PR_ST_1 , ACE_SYNCH_DECL >
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::operator delete ( void *  ,
void *   
)

This operator is necessary to complement the class-specific operator new above. Unfortunately, it's not portable to all C++ compilers...

template<PR_ST_1 , ACE_SYNCH_DECL >
void * ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::operator new ( size_t  n)

Overloaded new operator. This method unobtrusively records if a <Svc_Handler> is allocated dynamically, which allows it to clean itself up correctly whether or not it's allocated statically or dynamically.

template<PR_ST_1 , ACE_SYNCH_DECL >
void * ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::operator new ( size_t  n,
void *  p 
)

This operator permits "placement new" on a per-object basis.

template<PR_ST_1 , ACE_SYNCH_DECL >
ACE_PEER_STREAM & ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::peer ( void  ) const

Returns the underlying PEER_STREAM. Used by <ACE_Acceptor::accept> and <ACE_Connector::connect> factories

template<PR_ST_1 , ACE_SYNCH_DECL >
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::recycle ( void *  = 0)
virtual

Upcall made by the recycler when it is about to recycle the connection. This gives the object a chance to prepare itself for recycling. Return 0 if the object is ready for recycling, -1 on failures.

template<PR_ST_1 , ACE_SYNCH_DECL >
ACE_Recyclable_State ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::recycle_state ( void  ) const
virtual

Call this method if you want to get/set the state of the Svc_Handler. If the object does not have a recycler, this call will have no effect (and the accessor will return ACE_RECYCLABLE_UNKNOWN).

template<PR_ST_1 , ACE_SYNCH_DECL >
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::recycle_state ( ACE_Recyclable_State  new_state)
virtual
template<PR_ST_1 , ACE_SYNCH_DECL >
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::recycler ( ACE_Connection_Recycling_Strategy recycler,
const void *  recycling_act 
)
virtual

Set the recycler and the recycling_act that is used during purging and caching.

template<PR_ST_1 , ACE_SYNCH_DECL >
ACE_Connection_Recycling_Strategy * ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::recycler ( void  ) const
virtual

Get the recycler.

template<PR_ST_1 , ACE_SYNCH_DECL >
const void * ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::recycling_act ( void  ) const
virtual

Get the recycling act.

template<PR_ST_1 , ACE_SYNCH_DECL >
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::set_handle ( ACE_HANDLE  h)
virtual

Set the underlying handle associated with the <peer_>.

Reimplemented from ACE_Event_Handler.

template<PR_ST_1 , ACE_SYNCH_DECL >
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::shutdown ( void  )

Close down the descriptor and unregister from the Reactor.

Member Data Documentation

template<ACE_PEER_STREAM_1 , ACE_SYNCH_DECL >
bool ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >::closing_
protected

Keeps track of whether we are in the process of closing (required to avoid circular calls to <handle_close>).

template<ACE_PEER_STREAM_1 , ACE_SYNCH_DECL >
bool ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >::dynamic_
protected

Have we been dynamically created?

template<ACE_PEER_STREAM_1 , ACE_SYNCH_DECL >
ACE_PEER_STREAM ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >::peer_
protected

Maintain connection with client.

template<ACE_PEER_STREAM_1 , ACE_SYNCH_DECL >
ACE_Connection_Recycling_Strategy* ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >::recycler_
protected

Pointer to the connection recycler.

template<ACE_PEER_STREAM_1 , ACE_SYNCH_DECL >
const void* ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >::recycling_act_
protected

Asynchronous Completion Token (ACT) to be used to when talking to the recycler.


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