PaCO++.idl

Go to the documentation of this file.

// Written by André Ribes 2002

#ifndef __PaCO_idl__
#define __PaCO_idl__

// This file contains all the definitions idl for PaCO++

module PaCO
{  
  // Distribution Structures
  enum distLoc_t { none, ClientSide, ServerSide, CommSide };

  // Description of all the data
  typedef struct PacoGlobalData_s
  {
    unsigned long len;
    unsigned long unit_size;
    unsigned long cyclic;   // how it is distributed : 0:BLOCK, 1:CYCLIC(1), n>=2:CYCLIC(n)
  } PacoGlobalData_t;

  // Description of a particular data
  // a native type is needed for a pointer to data
  typedef struct PacoLocalData_s 
  {
    unsigned long rank;
    unsigned long start;  // global offset
    unsigned long len;    // number of element
    // a native type is needed for a pointer to data
  } PacoLocalData_t;

  // PaCO object Topology
  typedef struct PacoTopology_s 
  {
    unsigned long total;
  } PacoTopology_t;

  // Permits to init the bib
  typedef struct PacoInitData_s
  {
    PacoGlobalData_t  gd;
    PacoLocalData_t ld;
  } PacoInitData_t;

  typedef sequence<PacoLocalData_t> seqLocalData_t; 

  typedef struct DistributedData_s 
  {
    PacoTopology_t    topo;    /* dest ou source */
    PacoGlobalData_t  gd;
    seqLocalData_t    dist;    /* dest ou source */
    distLoc_t             mode; /* library mode */
  } DistributedData_t;

  // Connection informations
  struct ConnectionInfos
  {
    // version simple a refaire
    sequence<string> nodes;
    short request_uid;
    PacoTopology_t serveur_topo;
  };

  // Interfaces
  interface ParallelKernel 
  {
    // For clients stubs to call the InterfaceManager
    // Get connection informations
    ConnectionInfos getConnectionInfos();
  };

  // A PaCO++ interface parallel or object node parallel
  interface InterfaceParallel : ParallelKernel
  { 
    // For the servant
    
    // Get the logical Rank
    short getMyRank();
    // Get the total Number of nodes
    short getTotalNode();
    // Get the deploy Rank
    short getDeployRank();

    // The InterfaceManager call this method to initialize the InterfaceParallel
    void init_InterfaceParallel(in short myRank, in short totalNode, in PacoTopology_t topo);
    //void init_InterfaceParallel(in short totalNode);
    // To inform the interface manager
    void deploy(in short rank);

    // Return interface manager
    void refReturnObject(in string ref);
    void connect_return_object(in short client_id);

    // FOR EXCEPTION HANDLING
    // NOT COMPLETELY IMPLEMENTED
    typedef sequence<string> ref;
    void setRef(in ref ref_nodes);
    void addException(in short except);
  };

  // The interface manager
  interface InterfaceManager : ParallelKernel
  {
    // Initialize the InterfaceManager
    // void setConnectionInfos(in ConnectionInfos infos); // deprecated
    void setTotalNode(in short totalNode);
    void setTopo(in PacoTopology_t topo);
    //short getTotalNode();
    void setNewNode(in string node, in short rank);
    void setWorkNode(in short totalNode);
    void setReturn(in string ref);
    string getReturn();
    void return_ok(in short client_id);
    short getClientId();
  };
};

#endif