ColCOWS_Module.idl

//===========================================================================//
//    
//    Description: CORBA interface for ColCOWS objects
//    Filename: colcows/ColCOWSModule.idl
//    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_MODULE_IDL__
#define __COLCOWS_MODULE_IDL__

#pragma prefix "colcows"

//! ColCOWS IDL module
module ColCOWS {
  
  //! ColCOWS exception
  exception CorbaException {
    short   kind; 
    string  info;
    string  file; 
    long    line;
  };

  // ========== type ========== //

  //! object reference description
  struct IdlObjectDesc {
    //    unsigned long  num_node;
    string         obj_id;
    string         obj_kind;
    any            obj_ref;
  };  

  //! sequence of object reference description
  typedef sequence<IdlObjectDesc> IdlObjectDescSeq;
  
  // forward declaration
  interface NodeInterface;

#ifdef __DEPRECATED_IDL__

  //! Description of a ColCOWS Node
  struct IdlNodeDesc {
    //! Kind of the Workspace node ("proxy", "node", "master" ...)
    string         node_kind;
    //! Number of the node among the node hierarchy
    unsigned long  num_node;
    //! Max number of its descendants among the node hierarchy
    unsigned long  max_descendant;
    //! Is the node activated
    boolean        activated;
    //! Reference on its Node interface
    NodeInterface  node_ref;
    //! Sequence of reference descriptions collected by the node 
    IdlObjectDescSeq     ref_seq;
    //! Sequence of children description
    sequence<IdlNodeDesc> children_seq;
  };

  //! Sequence of ColCOWS Node descriptions
  typedef sequence<IdlNodeDesc> IdlNodeDescSeq;

#else

  // forward declaration
  struct IdlNodeDesc;

  //! Sequence of ColCOWS Node descriptions
  typedef sequence<IdlNodeDesc> IdlNodeDescSeq;

  //! Description of a ColCOWS Node
  struct IdlNodeDesc {
    //! Kind of the Workspace node ("proxy", "node", "master" ...)
    string         node_kind;
    //! Number of the node among the node hierarchy
    unsigned long  num_node;
    //! Max number of its descendants among the node hierarchy
    unsigned long  max_descendant;
    //! Is the node activated
    boolean        activated;
    //! Reference on its Node interface
    NodeInterface  node_ref;
    //! Sequence of reference descriptions collected by the node 
    IdlObjectDescSeq     ref_seq;
    //! Sequence of children description
    IdlNodeDescSeq children_seq;
  };

#endif // __DEPRECATED_IDL__

  //! object reference description
  struct IdlWorkspaceDesc {
    //! Workspace Id
    string         ws_id;
    //! Workspace Kind
    string         ws_kind;
    //! Number of nodes in the workspace
    unsigned long  nb_nodes;
    //! Is the workspace activated
    boolean        activated;
    //! Number of connection
    unsigned long  num_connection;
    //! Reference on the root ColCOWS Node
    NodeInterface  enter_node_ref;
    //! Root ColCOWS Node description
    IdlNodeDesc    enter_node;
  };
  typedef sequence<IdlWorkspaceDesc> IdlWorkspaceDescSeq;
  

  //===========================================================================//
  //                         Generic ColCOWS Interface                         //
  //===========================================================================//

  //! Generic ColCOWS Interface
  interface NodeInterface {

    //=================================================================
    //                       Deployment 
    //=================================================================
    
    //! set the workspace description [protected]
    oneway void setWorkspace(in IdlWorkspaceDesc ws_desc );

    //! set the description of a node's child description [protected]
    void setChildNode(in IdlNodeDesc node_desc) raises (CorbaException);

    //=================================================================
    
    //! get the workspace description [public]
    void getNode(in unsigned long num_node, out IdlNodeDesc node_desc) raises (CorbaException);

    //! get the workspace description [public]
    void getWorkspace(out IdlWorkspaceDesc ws_desc) raises (CorbaException);

    //=================================================================
    
    //! get the remote workspace description [public]
    void getRemoteWorkspace( in unsigned long num_connection, 
                             out IdlWorkspaceDesc ws_desc) raises (CorbaException);
    
    //! set the remote workspace description [protected]
    oneway void setRemoteWorkspace( in unsigned long num_connection, 
                             in IdlWorkspaceDesc ws_desc, 
                             in boolean initiator);

    //! release the remote workspace description [protected]
    oneway void releaseRemoteWorkspace( in unsigned long num_connection );
        
    //=================================================================

    //! test if the workspace is activated [public]
    boolean isActivated() raises (CorbaException);
    
    //! test if the workspace is ready to receive connections [public]
    boolean isReady() raises (CorbaException);
    
    //! test if the collective node is connected [public]
    boolean isConnected( in unsigned long num_connection ) raises (CorbaException);

    //! get the connection number [public]
    unsigned long getNumConnection( in string ws_id, in string ws_kind ) raises (CorbaException);

    //! get a unique connection number [public]
    void getCommonNumConnection( inout unsigned long num_connection ) raises (CorbaException);

  };
 
}; // end of module COLCOWS

#endif // __COLCOWS_MODULE_IDL__

// EOF

---