ColCOWS_EventHandlerManager.hh

//===========================================================================//
//    
//    Description: interface for user defined event handling classes
//    Filename: colcows/ColCOWS_EventHandlerManager.hh
//    Authors: Michael Dussere and Aurélien Esnard
//    
//===========================================================================//
//    
//    Copyright (C) 2003 INRIA and CNRS
//    
//    This library is free software; you can redistribute it and/or
//    modify it under the terms of the GNU Lesser General Public
//    License as published by the Free Software Foundation; either
//    version 2.1 of the License, or (at your option) any later version.
//    
//    This library is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//    Lesser General Public License for more details.
//    
//    You should have received a copy of the GNU Lesser General Public
//    License along with this library; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//    
//===========================================================================//

#ifndef __COLCOWS_EVENT_HANDLER_MANAGER_HH__
#define __COLCOWS_EVENT_HANDLER_MANAGER_HH__

//---------------------------------------------------------------------------//
#include "ColCOWS_Include.hh"
#include "ColCOWS_Debug.hh" 
//---------------------------------------------------------------------------//

namespace ColCOWS {
  class EventHandler;
}

__COLCOWS_BEGIN__

class Node;

//! ColCOWS event handler manger
/** 
 * The EventHandlers allow the user to catch and react to events of workspace life-cycle
 * (activation, connection, disconnection). This class manages several event handlers and 
 * forwards them the ColCOWS events.
 *
 */
class EventHandlerManager : public std::map<unsigned int, EventHandler * >
{

  //================================================//
  //=========== class standard interface ===========//
public:
  friend class Node;

  //! constructor
  EventHandlerManager();
  
  //! destructor
  virtual ~EventHandlerManager();

  //=========================================//
  //=========== public  interface ===========//
public:

  //! add an event handler in the manager
  unsigned int addEventHandler( EventHandler * event_handler );

  //! remove an event handler from the manager
  void removeEventHandler( unsigned int key );

  //! get ColCOWS Node pointer
  inline Node * getColCOWSNode( ) const { return _colcows_node; }

  //! get ColCOWS Node pointer
  inline void setColCOWSNode( Node * colcows_node ) { _colcows_node = colcows_node; }

//   //============ Activation =================//
//
//   //! wait end of activation
//   bool waitActivation() ;
//
//   //! wait end of activation
//   bool waitDeactivation() ;
//
//   //=========== Connection ==================//
//
//   //! wait the connection of a remote workspace
//   unsigned long waitConnection( const char* ws_id, const char * ws_kind ) ;
//
//   //! wait the disconnection of a remote workspace
//   unsigned long waitDisconnection( const char* ws_id, const char * ws_kind ) ;

  //=========================================//
  //=========== public  interface ===========//
protected:

  //! treatment on the activation of the workspace
  void onActivation();

  //! treatment on the deactivation of the workspace
  void onDeactivation();

  //! treatment on the connection of a workspace
  void onConnection( unsigned long num_connection, bool initiator );

  //! treatment on a disconnection 
  void onDisconnection( unsigned long num_connection );

protected:

  //! associated Node
  Node * _colcows_node;

  //! max key
  unsigned int _max_key;

};

__COLCOWS_END__

#endif // __COLCOWS_EVENT_HANDLER_HH__

// EOF

---