// -*- C++ -*-
/**
* @file ESF_Proxy_Admin.h
*
* $Id$
*
* @author Carlos O'Ryan (coryan@cs.wustl.edu)
*
* http://doc.ece.uci.edu/~coryan/EC/index.html
*/
#ifndef TAO_ESF_PROXY_ADMIN_H
#define TAO_ESF_PROXY_ADMIN_H
#include "orbsvcs/ESF/ESF_Proxy_Collection.h"
#include "orbsvcs/ESF/ESF_Worker.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
TAO_BEGIN_VERSIONED_NAMESPACE_DECL
/**
* @class TAO_ESF_Proxy_Admin
*
* @brief Implement common tasks in the Admin interfaces.
*
*
Requirements
*
* The EVENT_CHANNEL interface must implement:
*
* @verbatim
* /// create a new proxy
* void create_proxy (PROXY*&);
*
* /// destroy a proxy
* void destroy_proxy (PROXY*);
*
* /// create a proxy collection
* void create_proxy_collection (TAO_ESF_Proxy_Collection*&);
*
* /// destroy a proxy collection
* void destroy_proxy_collection (TAO_ESF_Proxy_Collection*&);
* @endverbatim
*
* In addition to the requirements imposed by
* TAO_ESF_Proxy_Collection<>, the PROXY interface must define:
*
* @verbatim
* /// The T_ptr for the IDL interface implemented by the PROXY.
* typename .... _ptr_type;
*
* /// The T_var for the IDL interface implemented by the PROXY.
* typename .... _var_type;
*
* /// activate the proxy and return the object reference
* PROXY::_ptr_type
* PROXY::activate (void) throw ();
* @endverbatim
*
*/
template
class TAO_ESF_Proxy_Admin
{
public:
/// Constructor, allocate the internal collection
TAO_ESF_Proxy_Admin (EVENT_CHANNEL *ec);
/// Cleanup internal resources, destroy the internal collection
virtual ~TAO_ESF_Proxy_Admin (void);
/// Iterate over its internal collection.
void for_each (TAO_ESF_Worker *worker);
// @todo We should use INTERFACE::_ptr_type or PROXY::_ptr_type, but
// the MSVC compiler (v6.0) gets confused when we do so. So we have
// to choose for the lesser evil. The code works because TAO uses
// pointers to implement the _ptr types, and that is OK because this
// code is supposed to run under TAO only.
/// Create a new PROXY and activate it.
virtual INTERFACE*
obtain (void);
/**
* The Event Channel that owns this Admin object is going
* down. Invoke on all the proxies, cleanup the
* collection and prepare to terminate.
*/
virtual void shutdown (void);
/**
* A has connected, this is invoked when the proxy's client
* has invoked the connect_xxx_yyy() method.
* The default implementation is a no-op.
*/
virtual void connected (PROXY *proxy);
/**
* A has reconnected, i.e. its client has invoked the
* connect_xxx_yyy() method, but the proxy was connected already.
* The default implementation delegates on the collection
* method
*/
virtual void reconnected (PROXY *proxy);
/**
* A has been disconnected. The default implementation
* removes the object from the collection and deactivates the
* proxy.
*/
virtual void disconnected (PROXY *proxy);
protected:
/// The Event Channel we belong to
EVENT_CHANNEL *event_channel_;
private:
/// Shorthand for the Proxy collection
typedef TAO_ESF_Proxy_Collection Collection;
/// The proxy collection object
Collection *collection_;
};
// ****************************************************************
template
class TAO_ESF_RefCountedRef
{
public:
TAO_ESF_RefCountedRef (COUNTED *counted);
~TAO_ESF_RefCountedRef ();
private:
TAO_ESF_RefCountedRef (TAO_ESF_RefCountedRef const & );
TAO_ESF_RefCountedRef& operator= (TAO_ESF_RefCountedRef const & );
COUNTED *counted_;
};
// ****************************************************************
TAO_END_VERSIONED_NAMESPACE_DECL
#if defined (__ACE_INLINE__)
#include "orbsvcs/ESF/ESF_Proxy_Admin.inl"
#endif /* __ACE_INLINE__ */
#if defined (ACE_TEMPLATES_REQUIRE_SOURCE)
#include "orbsvcs/ESF/ESF_Proxy_Admin.cpp"
#endif /* ACE_TEMPLATES_REQUIRE_SOURCE */
#if defined (ACE_TEMPLATES_REQUIRE_PRAGMA)
#pragma implementation ("ESF_Proxy_Admin.cpp")
#endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */
#endif /* TAO_ESF_PROXY_ADMIN_H */