#include <Svc_Handler.h>
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_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) |
Protected Attributes | |
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_ |
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.
typedef ACE_PEER_STREAM_ADDR ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >::addr_type |
typedef ACE_PEER_STREAM ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >::stream_type |
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 () | |||
) | [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< PR_ST_1, ACE_SYNCH_DECL >::~ACE_Svc_Handler | ( | void | ) | [inline, virtual] |
Destructor.
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::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< PR_ST_1, ACE_SYNCH_DECL >::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.
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::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< PR_ST_1, ACE_SYNCH_DECL >::dump | ( | void | ) | const [inline] |
Dump the state of an object.
Reimplemented from ACE_Task< ACE_SYNCH_USE >.
Reimplemented in ACE_Buffered_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >.
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::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.
ACE_HANDLE ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::get_handle | ( | void | ) | const [inline, virtual] |
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 | |||
) | [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< PR_ST_1, ACE_SYNCH_DECL >::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_PEER_STREAM_1, ACE_SYNCH_DECL >.
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::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.
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::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< PR_ST_1, ACE_SYNCH_DECL >::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< PR_ST_1, ACE_SYNCH_DECL >::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.
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::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< PR_ST_1, ACE_SYNCH_DECL >::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< PR_ST_1, ACE_SYNCH_DECL >::operator new | ( | size_t | n, | |
void * | p | |||
) | [inline] |
This operator permits "placement new" on a per-object basis.
void * ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::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_PEER_STREAM & ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::peer | ( | void | ) | const [inline] |
Returns the underlying PEER_STREAM. Used by <ACE_Acceptor::accept> and <ACE_Connector::connect> factories
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::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.
int ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::recycle_state | ( | ACE_Recyclable_State | new_state | ) | [inline, virtual] |
ACE_Recyclable_State ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::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).
ACE_Connection_Recycling_Strategy * ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::recycler | ( | void | ) | const [inline, virtual] |
Get the recycler.
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::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.
const void * ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::recycling_act | ( | void | ) | const [inline, virtual] |
Get the recycling act.
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::set_handle | ( | ACE_HANDLE | h | ) | [inline, virtual] |
void ACE_Svc_Handler< PR_ST_1, ACE_SYNCH_DECL >::shutdown | ( | void | ) | [inline] |
Close down the descriptor and unregister from the Reactor.
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>).
bool ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >::dynamic_ [protected] |
Have we been dynamically created?
ACE_PEER_STREAM ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >::peer_ [protected] |
Maintain connection with client.
ACE_Connection_Recycling_Strategy* ACE_Svc_Handler< ACE_PEER_STREAM_1, ACE_SYNCH_DECL >::recycler_ [protected] |
Pointer to the connection recycler.
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.