TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE > Class Template Reference

Implement common tasks in the Admin interfaces. More...

#include <ESF_Proxy_Admin.h>

Inheritance diagram for TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE >:

[legend]Collaboration diagram for TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE >:

[legend]List of all members.

Public Member Functions
	TAO_ESF_Proxy_Admin (EVENT_CHANNEL *ec)
	Constructor, allocate the internal collection.
virtual	~TAO_ESF_Proxy_Admin (void)
	Cleanup internal resources, destroy the internal collection.
Protected Attributes
EVENT_CHANNEL *	event_channel_
	The Event Channel we belong to.
Private Types
typedef TAO_ESF_Proxy_Collection< PROXY >	Collection
	Shorthand for the Proxy collection.
Private Attributes
Collection *	collection_
	The proxy collection object.

---

Detailed Description

template<class EVENT_CHANNEL, class PROXY, class INTERFACE>
class TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE >

Implement common tasks in the Admin interfaces.

Requirements

The EVENT_CHANNEL interface must implement:

 * void create_proxy (PROXY*&);
 * // create a new proxy
 *
 * void destroy_proxy (PROXY*);
 * // destroy a proxy
 *
 * void create_proxy_collection (TAO_ESF_Proxy_Collection<PROXY>*&);
 * // create a proxy collection
 *
 * void destroy_proxy_collection (TAO_ESF_Proxy_Collection<PROXY>*&);
 * // destroy a proxy collection
 * 

In addition to the requirements imposed by TAO_ESF_Proxy_Collection<>, the PROXY interface must define:

 * typename .... _ptr_type;
 * // The T_ptr for the IDL interface implemented by the PROXY.
 *
 * typename .... _var_type;
 * // The T_var for the IDL interface implemented by the PROXY.
 *
 * PROXY::_ptr_type
 * PROXY::activate (ACE_ENV_SINGLE_ARG_DECL_NOT_USED) throw ();
 * // activate the proxy and return the object reference
 * 

Definition at line 65 of file ESF_Proxy_Admin.h.

---

Member Typedef Documentation

template<class EVENT_CHANNEL, class PROXY, class INTERFACE> typedef TAO_ESF_Proxy_Collection<PROXY> TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE >::Collection [private]

Shorthand for the Proxy collection. Definition at line 131 of file ESF_Proxy_Admin.h.

---

Constructor & Destructor Documentation

template<class EVENT_CHANNEL, class PROXY, class INTERFACE> TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE >::TAO_ESF_Proxy_Admin (  EVENT_CHANNEL *  ec  )

Constructor, allocate the internal collection. Definition at line 16 of file ESF_Proxy_Admin.cpp. References TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE >::event_channel_. : event_channel_ (ec) { this->event_channel_->create_proxy_collection (this->collection_); }

template<class EVENT_CHANNEL, class PROXY, class INTERFACE> TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE >::~TAO_ESF_Proxy_Admin (  void   )  [virtual]

Cleanup internal resources, destroy the internal collection. Definition at line 24 of file ESF_Proxy_Admin.cpp. References TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE >::event_channel_. { this->event_channel_->destroy_proxy_collection (this->collection_); }

---

Member Data Documentation

template<class EVENT_CHANNEL, class PROXY, class INTERFACE> Collection* TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE >::collection_ [private]

The proxy collection object. Definition at line 134 of file ESF_Proxy_Admin.h.

template<class EVENT_CHANNEL, class PROXY, class INTERFACE> EVENT_CHANNEL* TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE >::event_channel_ [protected]

The Event Channel we belong to. A has been disconnected. The default implementation removes the object from the collection and deactivates the proxy. Definition at line 121 of file ESF_Proxy_Admin.h. Referenced by TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE >::TAO_ESF_Proxy_Admin(), and TAO_ESF_Proxy_Admin< EVENT_CHANNEL, PROXY, INTERFACE >::~TAO_ESF_Proxy_Admin().

---

The documentation for this class was generated from the following files:

• ESF_Proxy_Admin.h
• ESF_Proxy_Admin.cpp

---