ACE  6.0.6
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
ACE_Cached_Connect_Strategy Class Reference

A connection strategy which caches connections to peers (represented by SVC_HANDLER instances), thereby allowing subsequent re-use of unused, but available, connections. More...

#include <Strategies_T.h>

Inheritance diagram for ACE_Cached_Connect_Strategy:
Inheritance graph
[legend]
Collaboration diagram for ACE_Cached_Connect_Strategy:
Collaboration graph
[legend]

List of all members.

Public Types

typedef ACE_Creation_Strategy
< SVC_HANDLER > 
creation_strategy_type
typedef ACE_Connect_Strategy
< SVC_HANDLER,
ACE_PEER_CONNECTOR_2 > 
connect_strategy_type
typedef
ACE_Concurrency_Strategy
< SVC_HANDLER > 
concurrency_strategy_type
typedef ACE_Recycling_Strategy
< SVC_HANDLER > 
recycling_strategy_type
typedef ACE_Creation_Strategy
< SVC_HANDLER > 
CREATION_STRATEGY
typedef
ACE_Concurrency_Strategy
< SVC_HANDLER > 
CONCURRENCY_STRATEGY
typedef ACE_Recycling_Strategy
< SVC_HANDLER > 
RECYCLING_STRATEGY
typedef ACE_Connect_Strategy
< SVC_HANDLER,
ACE_PEER_CONNECTOR_2 > 
CONNECT_STRATEGY
typedef
ACE_Cached_Connect_Strategy
< SVC_HANDLER,
ACE_PEER_CONNECTOR_2, MUTEX > 
SELF
typedef
ACE_Refcounted_Hash_Recyclable
< ACE_PEER_CONNECTOR_ADDR > 
REFCOUNTED_HASH_RECYCLABLE_ADDRESS
typedef
ACE_Hash_Map_Manager_Ex
< REFCOUNTED_HASH_RECYCLABLE_ADDRESS,
SVC_HANDLER *, ACE_Hash
< REFCOUNTED_HASH_RECYCLABLE_ADDRESS >
, ACE_Equal_To
< REFCOUNTED_HASH_RECYCLABLE_ADDRESS >
, ACE_Null_Mutex
CONNECTION_MAP
typedef CONNECTION_MAP::ITERATOR CONNECTION_MAP_ITERATOR
typedef CONNECTION_MAP::ENTRY CONNECTION_MAP_ENTRY
typedef ACE_Reverse_Lock< MUTEX > REVERSE_MUTEX

Public Member Functions

 ACE_Cached_Connect_Strategy (ACE_Creation_Strategy< SVC_HANDLER > *cre_s=0, ACE_Concurrency_Strategy< SVC_HANDLER > *con_s=0, ACE_Recycling_Strategy< SVC_HANDLER > *rec_s=0, MUTEX *mutex=0, bool delete_lock=false)
 Constructor.
virtual ~ACE_Cached_Connect_Strategy (void)
 Destructor.
virtual int open (ACE_Creation_Strategy< SVC_HANDLER > *cre_s, ACE_Concurrency_Strategy< SVC_HANDLER > *con_s, ACE_Recycling_Strategy< SVC_HANDLER > *rec_s)
virtual int make_svc_handler (SVC_HANDLER *&sh)
 Template method for making a new <svc_handler>
virtual int activate_svc_handler (SVC_HANDLER *svc_handler)
 Template method for activating a new svc_handler.
virtual int assign_recycler (SVC_HANDLER *svc_handler, ACE_Connection_Recycling_Strategy *recycler, const void *recycling_act)
virtual int prepare_for_recycling (SVC_HANDLER *svc_handler)
 Template method for preparing the svc_handler for recycling.
virtual int connect_svc_handler (SVC_HANDLER *&sh, const ACE_PEER_CONNECTOR_ADDR &remote_addr, ACE_Time_Value *timeout, const ACE_PEER_CONNECTOR_ADDR &local_addr, bool reuse_addr, int flags, int perms)
virtual int connect_svc_handler (SVC_HANDLER *&sh, SVC_HANDLER *&sh_copy, const ACE_PEER_CONNECTOR_ADDR &remote_addr, ACE_Time_Value *timeout, const ACE_PEER_CONNECTOR_ADDR &local_addr, bool reuse_addr, int flags, int perms)
virtual int purge (const void *recycling_act)
 Remove from cache.
virtual int cache (const void *recycling_act)
 Add to cache.
virtual int recycle_state (const void *recycling_act, ACE_Recyclable_State new_state)
 Get/Set <recycle_state>.
virtual ACE_Recyclable_State recycle_state (const void *recycling_act) const
 Get/Set recycle_state.
virtual int mark_as_closed (const void *recycling_act)
 Mark as closed.
virtual int mark_as_closed_i (const void *recycling_act)
virtual int cleanup_hint (const void *recycling_act, void **act_holder=0)
 Cleanup hint and reset <*act_holder> to zero if <act_holder != 0>.
virtual ACE_Creation_Strategy
< SVC_HANDLER > * 
creation_strategy (void) const
virtual ACE_Recycling_Strategy
< SVC_HANDLER > * 
recycling_strategy (void) const
virtual
ACE_Concurrency_Strategy
< SVC_HANDLER > * 
concurrency_strategy (void) const

Protected Member Functions

virtual int new_connection (SVC_HANDLER *&sh, const ACE_PEER_CONNECTOR_ADDR &remote_addr, ACE_Time_Value *timeout, const ACE_PEER_CONNECTOR_ADDR &local_addr, bool reuse_addr, int flags, int perms)
 Creates a new connection.
int find (REFCOUNTED_HASH_RECYCLABLE_ADDRESS &search_addr, CONNECTION_MAP_ENTRY *&entry)
 Find an idle handle.
virtual int purge_i (const void *recycling_act)
 Remove from cache (non-locking version).
virtual int cache_i (const void *recycling_act)
 Add to cache (non-locking version).
virtual int recycle_state_i (const void *recycling_act, ACE_Recyclable_State new_state)
 Set <recycle_state> (non-locking version).
virtual ACE_Recyclable_State recycle_state_i (const void *recycling_act) const
 Get <recycle_state> (non-locking version).
virtual int cleanup_hint_i (const void *recycling_act, void **act_holder)
 Cleanup hint and reset <*act_holder> to zero if <act_holder != 0>.
int check_hint_i (SVC_HANDLER *&sh, const ACE_PEER_CONNECTOR_ADDR &remote_addr, ACE_Time_Value *timeout, const ACE_PEER_CONNECTOR_ADDR &local_addr, bool reuse_addr, int flags, int perms, CONNECTION_MAP_ENTRY *&entry, int &found)
int find_or_create_svc_handler_i (SVC_HANDLER *&sh, const ACE_PEER_CONNECTOR_ADDR &remote_addr, ACE_Time_Value *timeout, const ACE_PEER_CONNECTOR_ADDR &local_addr, bool reuse_addr, int flags, int perms, CONNECTION_MAP_ENTRY *&entry, int &found)
virtual int connect_svc_handler_i (SVC_HANDLER *&sh, const ACE_PEER_CONNECTOR_ADDR &remote_addr, ACE_Time_Value *timeout, const ACE_PEER_CONNECTOR_ADDR &local_addr, bool reuse_addr, int flags, int perms, int &found)

Protected Attributes

CONNECTION_MAP connection_map_
 Table that maintains the cache of connected SVC_HANDLERs.
MUTEX * lock_
 Mutual exclusion for this object.
bool delete_lock_
 Mutual exclusion for this object.
REVERSE_MUTEXreverse_lock_
 Reverse lock.
CREATION_STRATEGYcreation_strategy_
 Creation strategy for an <Connector>.
bool delete_creation_strategy_
CONCURRENCY_STRATEGYconcurrency_strategy_
 Concurrency strategy for an <Connector>.
bool delete_concurrency_strategy_
RECYCLING_STRATEGYrecycling_strategy_
 Recycling strategy for an <Connector>.
bool delete_recycling_strategy_

Detailed Description

A connection strategy which caches connections to peers (represented by SVC_HANDLER instances), thereby allowing subsequent re-use of unused, but available, connections.

<ACE_Cached_Connect_Strategy> is intended to be used as a plug-in connection strategy for ACE_Strategy_Connector. It's added value is re-use of established connections.


Member Typedef Documentation

typedef ACE_Connect_Strategy<SVC_HANDLER, ACE_PEER_CONNECTOR_2> ACE_Cached_Connect_Strategy::CONNECT_STRATEGY

Reimplemented in ACE_Cached_Connect_Strategy_Ex.

typedef ACE_Cached_Connect_Strategy<SVC_HANDLER, ACE_PEER_CONNECTOR_2, MUTEX> ACE_Cached_Connect_Strategy::SELF

Constructor & Destructor Documentation

ACE_Cached_Connect_Strategy::ACE_Cached_Connect_Strategy ( ACE_Creation_Strategy< SVC_HANDLER > *  cre_s = 0,
ACE_Concurrency_Strategy< SVC_HANDLER > *  con_s = 0,
ACE_Recycling_Strategy< SVC_HANDLER > *  rec_s = 0,
MUTEX *  mutex = 0,
bool  delete_lock = false 
)

Constructor.

virtual ACE_Cached_Connect_Strategy::~ACE_Cached_Connect_Strategy ( void  ) [virtual]

Destructor.


Member Function Documentation

virtual int ACE_Cached_Connect_Strategy::activate_svc_handler ( SVC_HANDLER *  svc_handler) [virtual]

Template method for activating a new svc_handler.

virtual int ACE_Cached_Connect_Strategy::assign_recycler ( SVC_HANDLER *  svc_handler,
ACE_Connection_Recycling_Strategy recycler,
const void *  recycling_act 
) [virtual]

Template method for setting the recycler information of the svc_handler.

virtual int ACE_Cached_Connect_Strategy::cache ( const void *  recycling_act) [virtual]

Add to cache.

Implements ACE_Connection_Recycling_Strategy.

virtual int ACE_Cached_Connect_Strategy::cache_i ( const void *  recycling_act) [protected, virtual]

Add to cache (non-locking version).

Reimplemented in ACE_Cached_Connect_Strategy_Ex.

int ACE_Cached_Connect_Strategy::check_hint_i ( SVC_HANDLER *&  sh,
const ACE_PEER_CONNECTOR_ADDR &  remote_addr,
ACE_Time_Value timeout,
const ACE_PEER_CONNECTOR_ADDR &  local_addr,
bool  reuse_addr,
int  flags,
int  perms,
CONNECTION_MAP_ENTRY *&  entry,
int &  found 
) [protected]
virtual int ACE_Cached_Connect_Strategy::cleanup_hint ( const void *  recycling_act,
void **  act_holder = 0 
) [virtual]

Cleanup hint and reset <*act_holder> to zero if <act_holder != 0>.

Implements ACE_Connection_Recycling_Strategy.

virtual int ACE_Cached_Connect_Strategy::cleanup_hint_i ( const void *  recycling_act,
void **  act_holder 
) [protected, virtual]

Cleanup hint and reset <*act_holder> to zero if <act_holder != 0>.

Reimplemented in ACE_Cached_Connect_Strategy_Ex.

virtual ACE_Concurrency_Strategy<SVC_HANDLER>* ACE_Cached_Connect_Strategy::concurrency_strategy ( void  ) const [virtual]
virtual int ACE_Cached_Connect_Strategy::connect_svc_handler ( SVC_HANDLER *&  sh,
const ACE_PEER_CONNECTOR_ADDR &  remote_addr,
ACE_Time_Value timeout,
const ACE_PEER_CONNECTOR_ADDR &  local_addr,
bool  reuse_addr,
int  flags,
int  perms 
) [virtual]

Checks to see if there is already a <SVC_HANDLER> in the cache connected to the <remote_addr>. If so, we return this pointer. Otherwise we establish the connection, put it into the cache, and return the SVC_HANDLER pointer. <[NOTE]>: the <{reuse_addr}> argument does NOT control re-use of addresses in the cache. Rather, if the underlying protocol requires a "dead time" prior to re-use of its addresses (TCP is a classic example of this), <{and}> the protocol provides a means by which to defeat the dead time, setting this argument to non-zero will defeat the dead-time requirement. <{Dev. Note: We might want to consider enhancing the interface at some point so that this also controls re-use of the cache.}>

Reimplemented from ACE_Connect_Strategy< SVC_HANDLER, ACE_PEER_CONNECTOR_2 >.

virtual int ACE_Cached_Connect_Strategy::connect_svc_handler ( SVC_HANDLER *&  sh,
SVC_HANDLER *&  sh_copy,
const ACE_PEER_CONNECTOR_ADDR &  remote_addr,
ACE_Time_Value timeout,
const ACE_PEER_CONNECTOR_ADDR &  local_addr,
bool  reuse_addr,
int  flags,
int  perms 
) [virtual]

The default behavior delegates to the <connect> method of the <PEER_CONNECTOR::connect>. Please check the documentation in Connector.h for more details.

Reimplemented from ACE_Connect_Strategy< SVC_HANDLER, ACE_PEER_CONNECTOR_2 >.

virtual int ACE_Cached_Connect_Strategy::connect_svc_handler_i ( SVC_HANDLER *&  sh,
const ACE_PEER_CONNECTOR_ADDR &  remote_addr,
ACE_Time_Value timeout,
const ACE_PEER_CONNECTOR_ADDR &  local_addr,
bool  reuse_addr,
int  flags,
int  perms,
int &  found 
) [protected, virtual]

Reimplemented in ACE_Cached_Connect_Strategy_Ex.

virtual ACE_Creation_Strategy<SVC_HANDLER>* ACE_Cached_Connect_Strategy::creation_strategy ( void  ) const [virtual]
int ACE_Cached_Connect_Strategy::find ( REFCOUNTED_HASH_RECYCLABLE_ADDRESS search_addr,
CONNECTION_MAP_ENTRY *&  entry 
) [protected]

Find an idle handle.

int ACE_Cached_Connect_Strategy::find_or_create_svc_handler_i ( SVC_HANDLER *&  sh,
const ACE_PEER_CONNECTOR_ADDR &  remote_addr,
ACE_Time_Value timeout,
const ACE_PEER_CONNECTOR_ADDR &  local_addr,
bool  reuse_addr,
int  flags,
int  perms,
CONNECTION_MAP_ENTRY *&  entry,
int &  found 
) [protected]
virtual int ACE_Cached_Connect_Strategy::make_svc_handler ( SVC_HANDLER *&  sh) [virtual]

Template method for making a new <svc_handler>

virtual int ACE_Cached_Connect_Strategy::mark_as_closed ( const void *  recycling_act) [virtual]

Mark as closed.

Implements ACE_Connection_Recycling_Strategy.

virtual int ACE_Cached_Connect_Strategy::mark_as_closed_i ( const void *  recycling_act) [virtual]

Mark as closed (non-locking version). This method needs to be public as it is used in the cleanup of handlers where teh locked version causes a deadlock.

Implements ACE_Connection_Recycling_Strategy.

Reimplemented in ACE_Cached_Connect_Strategy_Ex.

virtual int ACE_Cached_Connect_Strategy::new_connection ( SVC_HANDLER *&  sh,
const ACE_PEER_CONNECTOR_ADDR &  remote_addr,
ACE_Time_Value timeout,
const ACE_PEER_CONNECTOR_ADDR &  local_addr,
bool  reuse_addr,
int  flags,
int  perms 
) [protected, virtual]

Creates a new connection.

virtual int ACE_Cached_Connect_Strategy::open ( ACE_Creation_Strategy< SVC_HANDLER > *  cre_s,
ACE_Concurrency_Strategy< SVC_HANDLER > *  con_s,
ACE_Recycling_Strategy< SVC_HANDLER > *  rec_s 
) [virtual]

This methods allow you to change the strategies used by the cached connector.

virtual int ACE_Cached_Connect_Strategy::prepare_for_recycling ( SVC_HANDLER *  svc_handler) [virtual]

Template method for preparing the svc_handler for recycling.

virtual int ACE_Cached_Connect_Strategy::purge ( const void *  recycling_act) [virtual]

Remove from cache.

Implements ACE_Connection_Recycling_Strategy.

virtual int ACE_Cached_Connect_Strategy::purge_i ( const void *  recycling_act) [protected, virtual]

Remove from cache (non-locking version).

Reimplemented in ACE_Cached_Connect_Strategy_Ex.

virtual int ACE_Cached_Connect_Strategy::recycle_state ( const void *  recycling_act,
ACE_Recyclable_State  new_state 
) [virtual]

Get/Set <recycle_state>.

Implements ACE_Connection_Recycling_Strategy.

virtual ACE_Recyclable_State ACE_Cached_Connect_Strategy::recycle_state ( const void *  recycling_act) const [virtual]

Get/Set recycle_state.

Implements ACE_Connection_Recycling_Strategy.

virtual int ACE_Cached_Connect_Strategy::recycle_state_i ( const void *  recycling_act,
ACE_Recyclable_State  new_state 
) [protected, virtual]

Set <recycle_state> (non-locking version).

Reimplemented in ACE_Cached_Connect_Strategy_Ex.

virtual ACE_Recyclable_State ACE_Cached_Connect_Strategy::recycle_state_i ( const void *  recycling_act) const [protected, virtual]

Get <recycle_state> (non-locking version).

Reimplemented in ACE_Cached_Connect_Strategy_Ex.

virtual ACE_Recycling_Strategy<SVC_HANDLER>* ACE_Cached_Connect_Strategy::recycling_strategy ( void  ) const [virtual]

Member Data Documentation

Concurrency strategy for an <Connector>.

Table that maintains the cache of connected SVC_HANDLERs.

Creation strategy for an <Connector>.

true if <Connector> created the concurrency strategy and thus should delete it, else false.

true if <Connector> created the creation strategy and thus should delete it, else false.

Mutual exclusion for this object.

true if <Connector> created the recycling strategy and thus should delete it, else false.

Mutual exclusion for this object.

Recycling strategy for an <Connector>.

Reverse lock.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines