ACE  6.0.6
Public Types | Public Member Functions | Protected Attributes
ACE_Svc_Handler Class 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:
Inheritance graph
Collaboration diagram for ACE_Svc_Handler:
Collaboration graph

List of all members.

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)
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)
recycler (void) const
 Get the recycler.
virtual const void * recycling_act (void) const
 Get the recycling act.
virtual int recycle (void *=0)

Protected Attributes

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

Detailed Description

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

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 () 

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  ) [virtual]


Member Function Documentation

void ACE_Svc_Handler::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.

int ACE_Svc_Handler::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.

void ACE_Svc_Handler::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).

void ACE_Svc_Handler::dump ( void  ) const

Dump the state of an object.

Reimplemented from ACE_Task< ACE_SYNCH_USE >.

Reimplemented in ACE_Buffered_Svc_Handler.

int ACE_Svc_Handler::fini ( void  ) [virtual]

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

ACE_HANDLE ACE_Svc_Handler::get_handle ( void  ) const [virtual]

Get the underlying handle associated with the <peer_>.

int ACE_Svc_Handler::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...

int ACE_Svc_Handler::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 in ACE_Buffered_Svc_Handler.

int ACE_Svc_Handler::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.

int ACE_Svc_Handler::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.

int ACE_Svc_Handler::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.

int ACE_Svc_Handler::open ( void *  = 0) [virtual]

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

void ACE_Svc_Handler::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.

void ACE_Svc_Handler::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...

void * ACE_Svc_Handler::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.

void * ACE_Svc_Handler::operator new ( size_t  n,
void *  p 

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

ACE_PEER_STREAM & ACE_Svc_Handler::peer ( void  ) const

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

int ACE_Svc_Handler::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.

ACE_Recyclable_State ACE_Svc_Handler::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).

int ACE_Svc_Handler::recycle_state ( ACE_Recyclable_State  new_state) [virtual]
void ACE_Svc_Handler::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.

ACE_Connection_Recycling_Strategy * ACE_Svc_Handler::recycler ( void  ) const [virtual]

Get the recycler.

const void * ACE_Svc_Handler::recycling_act ( void  ) const [virtual]

Get the recycling act.

void ACE_Svc_Handler::set_handle ( ACE_HANDLE  h) [virtual]

Set the underlying handle associated with the <peer_>.

void ACE_Svc_Handler::shutdown ( void  )

Close down the descriptor and unregister from the Reactor.

Member Data Documentation

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

bool ACE_Svc_Handler::dynamic_ [protected]

Have we been dynamically created?

ACE_PEER_STREAM ACE_Svc_Handler::peer_ [protected]

Maintain connection with client.

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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines