The Transport Cache Manager for TAO. More...

#include <Transport_Cache_Manager_T.h>

Collaboration diagram for TAO::Transport_Cache_Manager_T< TT, TRDT, PSTRAT >:

Public Types
enum	Find_Result { CACHE_FOUND_NONE, CACHE_FOUND_CONNECTING, CACHE_FOUND_BUSY, CACHE_FOUND_AVAILABLE }
	results of a find More...
typedef TT	transport_type
typedef TRDT	transport_descriptor_type
typedef PSTRAT	purging_strategy
typedef Cache_ExtId_T < transport_descriptor_type >	Cache_ExtId
typedef Cache_IntId_T < transport_type >	Cache_IntId
typedef ACE_Hash_Map_Manager_Ex < Cache_ExtId, Cache_IntId, ACE_Hash< Cache_ExtId > , ACE_Equal_To< Cache_ExtId > , ACE_Null_Mutex >	HASH_MAP
typedef HASH_MAP::iterator	HASH_MAP_ITER
typedef ACE_Hash_Map_Entry < Cache_ExtId, Cache_IntId >	HASH_MAP_ENTRY
typedef TAO_Condition < TAO_SYNCH_MUTEX >	CONDITION
Public Member Functions
	Transport_Cache_Manager_T (int percent, purging_strategy purging_strategy, size_t cache_maximum, bool locked, const char orbid)
	Constructor.
	~Transport_Cache_Manager_T (void)
	Destructor.
int	cache_transport (transport_descriptor_type prop, transport_type transport, Cache_Entries_State state=ENTRY_IDLE_AND_PURGABLE)
	Add the transport to the cache.
Find_Result	find_transport (transport_descriptor_type prop, transport_type &transport, size_t &busy_count)
int	purge (void)
	Remove entries from the cache depending upon the strategy.
int	purge_entry (HASH_MAP_ENTRY *&entry)
	Purge the entry from the Cache Map.
void	mark_connected (HASH_MAP_ENTRY *&entry, bool state)
	Mark the entry as connected.
int	make_idle (HASH_MAP_ENTRY *&entry)
	Make the entry idle and ready for use.
void	set_entry_state (HASH_MAP_ENTRY *&entry, TAO::Cache_Entries_State state)
	Modify the state setting on the provided entry.
int	update_entry (HASH_MAP_ENTRY *&entry)
int	close (Connection_Handler_Set &handlers)
bool	blockable_client_transports (Connection_Handler_Set &handlers)
size_t	current_size (void) const
	Return the current size of the cache.
size_t	total_size (void) const
	Return the total size of the cache.
HASH_MAP &	map (void)
	Return the underlying cache map.
Private Types
typedef HASH_MAP_ENTRY **	DESCRIPTOR_SET
Private Member Functions
Find_Result	find (transport_descriptor_type prop, transport_type &transport, size_t &busy_count)
int	bind_i (Cache_ExtId &ext_id, Cache_IntId &int_id)
Find_Result	find_i (transport_descriptor_type prop, transport_type &transport, size_t &busy_count)
int	make_idle_i (HASH_MAP_ENTRY *entry)
	Non-locking version and actual implementation of make_idle ().
int	close_i (Connection_Handler_Set &handlers)
	Non-locking version and actual implementation of close ()
int	purge_entry_i (HASH_MAP_ENTRY *entry)
	Purge the entry from the Cache Map.
bool	is_entry_available_i (const HASH_MAP_ENTRY &entry)
bool	is_entry_connecting_i (const HASH_MAP_ENTRY &entry)
bool	is_entry_purgable_i (HASH_MAP_ENTRY &entry)
void	sort_set (DESCRIPTOR_SET &entries, int size)
	Sort the list of entries.
int	fill_set_i (DESCRIPTOR_SET &sorted_set)
bool	blockable_client_transports_i (Connection_Handler_Set &handlers)
	Non-locking version of blockable_client_transports ().
Static Private Member Functions
static int	cpscmp (const void a, const void b)
	Used by qsort.
Private Attributes
int	percent_
	The percentage of the cache to purge at one time.
purging_strategy *	purging_strategy_
	The underlying connection purging strategy.
HASH_MAP	cache_map_
	The hash map that has the connections.
TAO_SYNCH_MUTEX	cache_map_mutex_
ACE_Lock *	cache_lock_
	The lock that is used by the cache map.
size_t	cache_maximum_
	Maximum size of the cache.

Detailed Description

template<typename TT, typename TRDT, typename PSTRAT>
class TAO::Transport_Cache_Manager_T< TT, TRDT, PSTRAT >

The Transport Cache Manager for TAO.

This class provides interfaces associating a TAO_Cache_ExtId & TAO_Cache_IntId. This class is wrapper around the ACE_Hash_Map_Manager class which is used as a container to Cache the connections. This class protects the entries with a lock. The map is updated only by holding the lock. The more compelling reason to have the lock in this class and not in the Hash_Map is that, we do quite a bit of work in this class for which we need a lock.