ACE_Svc_Handler<, > Class Template ReferenceDefines the interface for a service that exchanges data with its connected peer. More...
Inheritance diagram for ACE_Svc_Handler<, >:
Collaboration diagram for ACE_Svc_Handler<, >:
Detailed Descriptiontemplate<ACE_PEER_STREAM_1, ACE_SYNCH_DECL>
Defines the interface for a service that exchanges data with its connected peer.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| typedef ACE_PEER_STREAM_ADDR ACE_Svc_Handler<, >::addr_type |
| typedef ACE_PEER_STREAM ACE_Svc_Handler<, >::stream_type |
Constructor & Destructor Documentation
| ACE_Svc_Handler<, >::ACE_Svc_Handler | ( | ACE_Thread_Manager * | thr_mgr = 0, |
|
| ACE_Message_Queue< ACE_SYNCH_USE > * | mq = 0, |
|||
| ACE_Reactor * | reactor = ACE_Reactor::instance () | |||
| ) | [inline] |
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.
| ACE_Svc_Handler<, >::~ACE_Svc_Handler | ( | void | ) | [inline, virtual] |
Destructor.
Member Function Documentation
| int ACE_Svc_Handler<, >::open | ( | void * | = 0 |
) | [inline, virtual] |
Activate the client handler. This is typically called by the ACE_Acceptor or ACE_Connector.
Reimplemented from ACE_Task_Base.
| int ACE_Svc_Handler<, >::close | ( | u_long | flags = 0 |
) | [inline, 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.
| int ACE_Svc_Handler<, >::idle | ( | u_long | flags = 0 |
) | [inline, 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.
| ACE_Recyclable_State ACE_Svc_Handler<, >::recycle_state | ( | void | ) | const [inline, 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).
| int ACE_Svc_Handler<, >::recycle_state | ( | ACE_Recyclable_State | new_state | ) | [inline, virtual] |
| void ACE_Svc_Handler<, >::cleanup_hint | ( | void ** | act_holder = 0 |
) | [inline, 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.
| int ACE_Svc_Handler<, >::init | ( | int | argc, | |
| ACE_TCHAR * | argv[] | |||
| ) | [inline, virtual] |
Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.
Reimplemented from ACE_Shared_Object.
| int ACE_Svc_Handler<, >::fini | ( | void | ) | [inline, virtual] |
Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.
Reimplemented from ACE_Shared_Object.
| int ACE_Svc_Handler<, >::info | ( | ACE_TCHAR ** | info_string, | |
| size_t | length | |||
| ) | const [inline, virtual] |
Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.
Reimplemented from ACE_Shared_Object.
| int ACE_Svc_Handler<, >::handle_close | ( | ACE_HANDLE | = ACE_INVALID_HANDLE, |
|
| ACE_Reactor_Mask | = ACE_Event_Handler::ALL_EVENTS_MASK | |||
| ) | [inline, 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.
| int ACE_Svc_Handler<, >::handle_timeout | ( | const ACE_Time_Value & | time, | |
| const void * | ||||
| ) | [inline, 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_HANDLE ACE_Svc_Handler<, >::get_handle | ( | void | ) | const [inline, virtual] |
| void ACE_Svc_Handler<, >::set_handle | ( | ACE_HANDLE | h | ) | [inline, virtual] |
| ACE_PEER_STREAM & ACE_Svc_Handler<, >::peer | ( | void | ) | const [inline] |
Returns the underlying PEER_STREAM. Used by <ACE_Acceptor::accept> and <ACE_Connector::connect> factories
| void * ACE_Svc_Handler<, >::operator new | ( | size_t | n | ) | [inline] |
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.
| ACE_BEGIN_VERSIONED_NAMESPACE_DECL void * ACE_Svc_Handler<, >::operator new | ( | size_t | n, | |
| void * | p | |||
| ) | [inline] |
This operator permits "placement new" on a per-object basis.
| void ACE_Svc_Handler<, >::destroy | ( | void | ) | [inline, 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).
| void ACE_Svc_Handler<, >::operator delete | ( | void * | obj | ) | [inline] |
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.
| void ACE_Svc_Handler<, >::operator delete | ( | void * | , | |
| void * | ||||
| ) | [inline] |
This operator is necessary to complement the class-specific operator new above. Unfortunately, it's not portable to all C++ compilers...
| void ACE_Svc_Handler<, >::shutdown | ( | void | ) | [inline] |
Close down the descriptor and unregister from the Reactor.
| void ACE_Svc_Handler<, >::dump | ( | void | ) | const [inline] |
Dump the state of an object.
Reimplemented from ACE_Task< ACE_SYNCH_USE >.
Reimplemented in ACE_Buffered_Svc_Handler<, >.
| void ACE_Svc_Handler<, >::recycler | ( | ACE_Connection_Recycling_Strategy * | recycler, | |
| const void * | recycling_act | |||
| ) | [inline, virtual] |
Set the recycler and the recycling_act that is used during purging and caching.
| ACE_Connection_Recycling_Strategy * ACE_Svc_Handler<, >::recycler | ( | void | ) | const [inline, virtual] |
Get the recycler.
| const void * ACE_Svc_Handler<, >::recycling_act | ( | void | ) | const [inline, virtual] |
Get the recycling act.
| int ACE_Svc_Handler<, >::recycle | ( | void * | = 0 |
) | [inline, 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.
Member Data Documentation
ACE_PEER_STREAM ACE_Svc_Handler<, >::peer_ [protected] |
Maintain connection with client.
bool ACE_Svc_Handler<, >::dynamic_ [protected] |
Have we been dynamically created?
bool ACE_Svc_Handler<, >::closing_ [protected] |
Keeps track of whether we are in the process of closing (required to avoid circular calls to <handle_close>).
ACE_Connection_Recycling_Strategy* ACE_Svc_Handler<, >::recycler_ [protected] |
Pointer to the connection recycler.
const void* ACE_Svc_Handler<, >::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:
Generated on Mon Sep 15 07:17:27 2008 for ACE by
1.5.5