// -----------------------------------------------------------------------
-// Copyright (C) 2006 - 2007 FRESCOR consortium partners:
+// Copyright (C) 2006 - 2008 FRESCOR consortium partners:
//
// Universidad de Cantabria, SPAIN
// University of York, UK
// Visual Tools S.A. SPAIN
// Rapita Systems Ltd UK
// Evidence ITALY
-//
+//
// See http://www.frescor.org for a link to partners' websites
//
// FRESCOR project (FP6/2005/IST/5-034026) is funded
//
//
// based on previous work (FSF) done in the FIRST project
-//
+//
// Copyright (C) 2005 Mälardalen University, SWEDEN
// Scuola Superiore S.Anna, ITALY
// Universidad de Cantabria, SPAIN
// FSF API web pages: http://marte.unican.es/fsf/docs
// http://shark.sssup.it/contrib/first/docs/
//
-// This file is part of FRSH API
-//
-// FRSH API is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation; either version 2, or (at your option)
-// any later version.
+// This file is part of FRSH (FRescor ScHeduler)
//
-// FRSH API 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
-// General Public License for more details.
+// FRSH is free software; you can redistribute it and/or modify it
+// under terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 2, or (at your option) any
+// later version. FRSH 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
+// General Public License for more details. You should have received a
+// copy of the GNU General Public License along with FRSH; see file
+// COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
+// Cambridge, MA 02139, USA.
//
-// You should have received a copy of the GNU General Public License
-// distributed with FRSH API; see file COPYING. If not, write to the
-// Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-// 02111-1307, USA.
-//
-// As a special exception, if you include this header file into source
-// files to be compiled, this header file does not by itself cause
-// the resulting executable to be covered by the GNU General Public
-// License. This exception does not however invalidate any other
-// reasons why the executable file might be covered by the GNU General
-// Public License.
+// As a special exception, including FRSH header files in a file,
+// instantiating FRSH generics or templates, or linking other files
+// with FRSH objects to produce an executable application, does not
+// by itself cause the resulting executable application to be covered
+// by the GNU General Public License. This exception does not
+// however invalidate any other reasons why the executable file might be
+// covered by the GNU Public License.
// -----------------------------------------------------------------------
//==============================================
// **//// /**///** ////////** /**//////**
// ** /** //** /** /** /**
// ** /** //** ******** /** /**
-// // // // //////// // //
+// // // // //////// // //
//
// FRSH(FRescor ScHeduler), pronounced "fresh"
//==============================================
-#ifndef FRSH_DISTRIBUTED_TYPES_H_
-#define FRSH_DISTRIBUTED_TYPES_H_
+#ifndef FRSH_DISTRIBUTED_TYPES_H_
+#define FRSH_DISTRIBUTED_TYPES_H_
+
+/**
+ * @file frsh_distributed_types.h
+ **/
#include "frsh_opaque_types.h"
+FRSH_CPP_BEGIN_DECLS
+
/**
* @addtogroup distributed
*
* @{
**/
-#define FRSH_DEFAULT_NETWORK_ID 1
-#define FRSH_NULL_NETWORK_ID 0
-
-
//opaque types for frsh endpoints
typedef FRSH_SEND_ENDPOINT_T_OPAQUE frsh_send_endpoint_t;
typedef FRSH_RECEIVE_ENDPOINT_T_OPAQUE frsh_receive_endpoint_t;
/**
- * The node_address type specifies the node address
- * in a communication-protocol-independent way. The actual
- * address is obtained via a configuration dependent mapping
- * function
+ * The network_address type specifies the node or multicast address in
+ * a communication-protocol-independent way. The actual address is
+ * obtained via a configuration dependent mapping function
**/
-typedef unsigned int frsh_node_address_t;
+typedef unsigned int frsh_network_address_t;
/**
- * The port type specifies the information that is
+ * The port type specifies the information that is
* necessary to get in contact with the thread in the
* receiving node, in a protocol-independent way.
* The actual port number is obtained via a configuration
* dependent mapping function
**/
-typedef unsigned int frsh_stream_id_t;
+typedef unsigned int frsh_stream_id_t;
/**
* Extra information protocol dependent opaque for the application.
* It can be used in different places: contract negotiation, extra
* endpoint info, extra status info...
**/
-typedef struct _protocol_info_t
-{
+typedef struct {
void *body;
int size;
} frsh_protocol_info_t;
+/**
+ * Protocol dependent information about the status of an endpoint
+ **/
+typedef struct {
+ void *body;
+ int size;
+} frsh_protocol_status_t;
+
+/**
+ * Protocol dependent information about extra parameters for
+ * send_endpoint definition.
+ **/
+typedef struct {
+ void *body;
+ int size;
+} frsh_send_endpoint_protocol_info_t;
+
+/**
+ * Protocol dependent information about extra parameters for
+ * receive_endpoint definition.
+ **/
+typedef struct {
+ void *body;
+ int size;
+} frsh_receive_endpoint_protocol_info_t;
+
/**
* Algorithm used when the queue is full to choose the message to reject
**/
-typedef enum _queue_rejection_policy_t
-{
+typedef enum {
/** A new message is admitted rejecting the oldest message in the
queue to make room for the newcomer **/
FRSH_QRP_OLDEST,
/** Incoming messages are rejected if the queue is full **/
FRSH_QRP_NEWCOMER
} frsh_queue_rejection_policy_t;
-
+
/**
* Queing information for endpoints
**/
-typedef struct _frsh_endpoint_queueing_info_t
-{
+typedef struct {
int queue_size; /** Size 0 means that there is no queue **/
frsh_queue_rejection_policy_t queue_policy;
} frsh_endpoint_queueing_info_t;
+typedef enum {
+ /** Network works OK **/
+ FRSH_ENS_UP,
+
+ /** Network is down **/
+ FRSH_ENS_DOWN
+} frsh_endpoint_network_status_t;
+
/*@}*/
-#endif /* !FRSH_DISTRIBUTED_TYPES_H_ */
+FRSH_CPP_END_DECLS
+
+#endif /* !FRSH_DISTRIBUTED_TYPES_H_ */
projects / frescor / frsh-include.git / blobdiff