frsh_distributed_types.h

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2007 FRESCOR consortium partners:
   3 //
   4 //    Universidad de Cantabria,              SPAIN
   5 //    University of York,                    UK
   6 //    Scuola Superiore Sant'Anna,            ITALY
   7 //    Kaiserslautern University,             GERMANY
   8 //    Univ. Politécnica  Valencia,           SPAIN
   9 //    Czech Technical University in Prague,  CZECH REPUBLIC
  10 //    ENEA                                   SWEDEN
  11 //    Thales Communication S.A.              FRANCE
  12 //    Visual Tools S.A.                      SPAIN
  13 //    Rapita Systems Ltd                     UK
  14 //    Evidence                               ITALY
  15 //
  16 //    See http://www.frescor.org for a link to partners' websites
  17 //
  18 //           FRESCOR project (FP6/2005/IST/5-034026) is funded
  19 //        in part by the European Union Sixth Framework Programme
  20 //        The European Union is not liable of any use that may be
  21 //        made of this code.
  22 //
  23 //
  24 //  based on previous work (FSF) done in the FIRST project
  25 //
  26 //   Copyright (C) 2005  Mälardalen University, SWEDEN
  27 //                       Scuola Superiore S.Anna, ITALY
  28 //                       Universidad de Cantabria, SPAIN
  29 //                       University of York, UK
  30 //
  31 //   FSF API web pages: http://marte.unican.es/fsf/docs
  32 //                      http://shark.sssup.it/contrib/first/docs/
  33 //
  34 //  This file is part of FRSH API
  35 //
  36 //  FRSH API is free software; you can  redistribute it and/or  modify
  37 //  it under the terms of  the GNU General Public License as published by
  38 //  the Free Software Foundation;  either  version 2, or (at  your option)
  39 //  any later version.
  40 //
  41 //  FRSH API  is distributed  in  the hope  that  it  will  be useful,  but
  42 //  WITHOUT  ANY  WARRANTY;     without  even the   implied   warranty  of
  43 //  MERCHANTABILITY  or  FITNESS FOR  A  PARTICULAR PURPOSE. See  the  GNU
  44 //  General Public License for more details.
  45 //
  46 //  You should have  received a  copy of  the  GNU  General Public License
  47 //  distributed  with  FRSH API;  see file COPYING.   If not,  write to the
  48 //  Free Software  Foundation,  59 Temple Place  -  Suite 330,  Boston, MA
  49 //  02111-1307, USA.
  50 //
  51 //  As a special exception, if you include this header file into source
  52 //  files to be compiled, this header file does not by itself cause
  53 //  the resulting executable to be covered by the GNU General Public
  54 //  License.  This exception does not however invalidate any other
  55 //  reasons why the executable file might be covered by the GNU General
  56 //  Public License.
  57 // -----------------------------------------------------------------------
  58
  59 //==============================================
  60 //  ******** *******    ******** **      **
  61 //  **///// /**////**  **////// /**     /**
  62 //  **      /**   /** /**       /**     /**
  63 //  ******* /*******  /*********/**********
  64 //  **////  /**///**  ////////**/**//////**
  65 //  **      /**  //**        /**/**     /**
  66 //  **      /**   //** ******** /**     /**
  67 //  //       //     // ////////  //      //
  68 //
  69 // FRSH(FRescor ScHeduler), pronounced "fresh"
  70 //==============================================
  71
  72 #ifndef         FRSH_DISTRIBUTED_TYPES_H_
  73 #define         FRSH_DISTRIBUTED_TYPES_H_
  74
  75 #include "frsh_opaque_types.h"
  76
  77 /**
  78  * @addtogroup distributed
  79  *
  80  * @{
  81  **/
  82
  83 /**
  84  * Type designating the network ids. They need not
  85  * be sequential numbers.
  86  **/
  87 typedef unsigned int       frsh_network_id_t;
  88
  89 #define FRSH_DEFAULT_NETWORK_ID         1
  90 #define FRSH_NULL_NETWORK_ID            0
  91
  92 //opaque types for frsh endpoints
  93 typedef FRSH_SEND_ENDPOINT_T_OPAQUE frsh_send_endpoint_t;
  94 typedef FRSH_RECEIVE_ENDPOINT_T_OPAQUE frsh_receive_endpoint_t;
  95
  96 /**
  97  * The node_address type specifies the node address
  98  * in a communication-protocol-independent way. The actual
  99  * address is obtained via a configuration dependent mapping
 100  * function
 101  **/
 102 typedef unsigned int  frsh_node_address_t;
 103
 104 /**
 105  * The port type specifies the information that is
 106  * necessary to get in contact with the thread in the
 107  * receiving node, in a protocol-independent way.
 108  * The actual port number is obtained via a configuration
 109  * dependent mapping function
 110  **/
 111 typedef unsigned int  frsh_port_t;
 112
 113 /*@}*/
 114
 115 #endif      /* !FRSH_DISTRIBUTED_TYPES_H_ */