const

[frescor/frsh-include.git] / frsh_distributed_types.h

diff --git a/frsh_distributed_types.h b/frsh_distributed_types.h
index ed213628b93bd2a53a587de7601aa964de29fd75..dcd774b6b9cd73d84b9cc5b7e9b4bbe988d0f6aa 100644 (file)
--- a/frsh_distributed_types.h
+++ b/frsh_distributed_types.h
@@ -69,21 +69,23 @@
 // 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;
@@ -93,7 +95,7 @@ typedef FRSH_RECEIVE_ENDPOINT_T_OPAQUE frsh_receive_endpoint_t;
  * a communication-protocol-independent way. The actual address is
  * obtained via a configuration dependent mapping function
  **/
-typedef unsigned int  frsh_network_address_t;
+typedef unsigned int frsh_network_address_t;
 
 /**
  * The port type specifies the information that is
@@ -102,15 +104,14 @@ typedef unsigned int  frsh_network_address_t;
  * 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;
@@ -118,17 +119,33 @@ typedef struct _protocol_info_t
 /**
  * Protocol dependent information about the status of an endpoint
  **/
-typedef struct _protocol_status_t
-{
+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,
@@ -140,22 +157,22 @@ typedef enum _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 _endpoint_network_status
-{
+typedef enum {
     /** Network works OK **/
     FRSH_ENS_UP,
 
     /** Network is down **/
     FRSH_ENS_DOWN
-} frsh_endpoint_network_status;
+} frsh_endpoint_network_status_t;
 
 /*@}*/
 
-#endif             /* !FRSH_DISTRIBUTED_TYPES_H_ */
+FRSH_CPP_END_DECLS
+
+#endif  /* !FRSH_DISTRIBUTED_TYPES_H_ */