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 /**
  76  * @file frsh_distributed_types.h
  77  **/
  78
  79 #include "frsh_opaque_types.h"
  80
  81 /**
  82  * @addtogroup distributed
  83  *
  84  * @{
  85  **/
  86
  87 #define FRSH_DEFAULT_NETWORK_ID  1
  88 #define FRSH_NULL_NETWORK_ID  0
  89
  90
  91 //opaque types for frsh endpoints
  92 typedef FRSH_SEND_ENDPOINT_T_OPAQUE frsh_send_endpoint_t;
  93 typedef FRSH_RECEIVE_ENDPOINT_T_OPAQUE frsh_receive_endpoint_t;
  94
  95 /**
  96  * The network_address type specifies the node or multicast address in
  97  * a communication-protocol-independent way. The actual address is
  98  * obtained via a configuration dependent mapping function
  99  **/
 100 typedef unsigned int frsh_network_address_t;
 101
 102 /**
 103  * The port type specifies the information that is
 104  * necessary to get in contact with the thread in the
 105  * receiving node, in a protocol-independent way.
 106  * The actual port number is obtained via a configuration
 107  * dependent mapping function
 108  **/
 109 typedef unsigned int frsh_stream_id_t;
 110
 111 /**
 112  * Extra information protocol dependent opaque for the application.
 113  * It can be used in different places: contract negotiation, extra
 114  * endpoint info, extra status info...
 115  **/
 116 typedef struct {
 117     void *body;
 118     int size;
 119 } frsh_protocol_info_t;
 120
 121 /**
 122  * Protocol dependent information about the status of an endpoint
 123  **/
 124 typedef struct {
 125    void *body;
 126    int size;
 127 } frsh_protocol_status_t;
 128
 129 /**
 130  * Protocol dependent information about extra parameters for
 131  * send_endpoint definition.
 132  **/
 133 typedef struct {
 134    void *body;
 135    int size;
 136 } frsh_send_endpoint_protocol_info_t;
 137
 138 /**
 139  * Protocol dependent information about extra parameters for
 140  * receive_endpoint definition.
 141  **/
 142 typedef struct {
 143    void *body;
 144    int size;
 145 } frsh_receive_endpoint_protocol_info_t;
 146
 147 /**
 148  * Algorithm used when the queue is full to choose the message to reject
 149  **/
 150 typedef enum {
 151     /** A new message is admitted rejecting the oldest message in the
 152         queue to make room for the newcomer **/
 153     FRSH_QRP_OLDEST,
 154
 155     /** Incoming messages are rejected if the queue is full **/
 156     FRSH_QRP_NEWCOMER
 157 } frsh_queue_rejection_policy_t;
 158
 159 /**
 160  * Queing information for endpoints
 161  **/
 162 typedef struct {
 163     int queue_size;  /** Size 0 means that there is no queue **/
 164     frsh_queue_rejection_policy_t queue_policy;
 165 } frsh_endpoint_queueing_info_t;
 166
 167
 168 typedef enum {
 169     /** Network works OK **/
 170     FRSH_ENS_UP,
 171
 172     /** Network is down **/
 173     FRSH_ENS_DOWN
 174 } frsh_endpoint_network_status;
 175
 176 /*@}*/
 177
 178 #endif  /* !FRSH_DISTRIBUTED_TYPES_H_ */