1 // -----------------------------------------------------------------------
2 // Copyright (C) 2006 - 2007 FRESCOR consortium partners:
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
11 // Thales Communication S.A. FRANCE
12 // Visual Tools S.A. SPAIN
13 // Rapita Systems Ltd UK
16 // See http://www.frescor.org for a link to partners' websites
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
24 // based on previous work (FSF) done in the FIRST project
26 // Copyright (C) 2005 Mälardalen University, SWEDEN
27 // Scuola Superiore S.Anna, ITALY
28 // Universidad de Cantabria, SPAIN
29 // University of York, UK
31 // FSF API web pages: http://marte.unican.es/fsf/docs
32 // http://shark.sssup.it/contrib/first/docs/
34 // This file is part of FRSH API
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)
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.
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
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
57 // -----------------------------------------------------------------------
59 //==============================================
60 // ******** ******* ******** ** **
61 // **///// /**////** **////// /** /**
62 // ** /** /** /** /** /**
63 // ******* /******* /********* /**********
64 // **//// /**///** ////////** /**//////**
65 // ** /** //** /** /** /**
66 // ** /** //** ******** /** /**
67 // // // // //////// // //
69 // FRSH(FRescor ScHeduler), pronounced "fresh"
70 //==============================================
72 #ifndef FRSH_DISTRIBUTED_TYPES_H_
73 #define FRSH_DISTRIBUTED_TYPES_H_
76 * @file frsh_distributed_types.h
79 #include "frsh_opaque_types.h"
82 * @addtogroup distributed
87 //opaque types for frsh endpoints
88 typedef FRSH_SEND_ENDPOINT_T_OPAQUE frsh_send_endpoint_t;
89 typedef FRSH_RECEIVE_ENDPOINT_T_OPAQUE frsh_receive_endpoint_t;
92 * The network_address type specifies the node or multicast address in
93 * a communication-protocol-independent way. The actual address is
94 * obtained via a configuration dependent mapping function
96 typedef unsigned int frsh_network_address_t;
99 * The port type specifies the information that is
100 * necessary to get in contact with the thread in the
101 * receiving node, in a protocol-independent way.
102 * The actual port number is obtained via a configuration
103 * dependent mapping function
105 typedef unsigned int frsh_stream_id_t;
108 * Extra information protocol dependent opaque for the application.
109 * It can be used in different places: contract negotiation, extra
110 * endpoint info, extra status info...
115 } frsh_protocol_info_t;
118 * Protocol dependent information about the status of an endpoint
123 } frsh_protocol_status_t;
126 * Protocol dependent information about extra parameters for
127 * send_endpoint definition.
132 } frsh_send_endpoint_protocol_info_t;
135 * Protocol dependent information about extra parameters for
136 * receive_endpoint definition.
141 } frsh_receive_endpoint_protocol_info_t;
144 * Algorithm used when the queue is full to choose the message to reject
147 /** A new message is admitted rejecting the oldest message in the
148 queue to make room for the newcomer **/
151 /** Incoming messages are rejected if the queue is full **/
153 } frsh_queue_rejection_policy_t;
156 * Queing information for endpoints
159 int queue_size; /** Size 0 means that there is no queue **/
160 frsh_queue_rejection_policy_t queue_policy;
161 } frsh_endpoint_queueing_info_t;
165 /** Network works OK **/
168 /** Network is down **/
170 } frsh_endpoint_network_status_t;
174 #endif /* !FRSH_DISTRIBUTED_TYPES_H_ */