unmarshal

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

diff --git a/frsh_shared_objects_types.h b/frsh_shared_objects_types.h
index 617bb4e96465f301901adaa706e91d1d909f216d..0513d5e98acb254510888d0c53043af7b44e3251 100644 (file)
--- a/frsh_shared_objects_types.h
+++ b/frsh_shared_objects_types.h
@@ -77,7 +77,7 @@
 #include "frsh_configuration_parameters.h"
 
 /**
- * @file frsh_shared_object_types.h
+ * @file frsh_shared_objects_types.h
  **/
 
 /**
@@ -87,26 +87,30 @@
  **/
 
 
-typedef char * frsh_sharedobj_id_t;     
-
-
 /** 
  *  Shared object handle:  It is an opaque type (i.e. the internal
  *  structure of this data type is implementation dependent).
  **/
 typedef FRSH_SHAREDOBJ_HANDLE_T_OPAQUE  frsh_sharedobj_handle_t; 
 
+/**
+ *  Shared object textual label
+ **/
+typedef char frsh_sharedobj_label_t[FRSH_MAX_SIZE_SHARED_OBJ_LABEL + 1];
 
 /**
- * Kind of shared object
+ * Kind of shared object: protected or unprotected
  */
-typedef enum {FRSH_SOK_UNPROTECTED, FRSH_SOK_PROTECTED}
-          frsh_sharedobj_kind_t;                           
+typedef enum 
+  {FRSH_SOK_UNPROTECTED, FRSH_SOK_PROTECTED}
+frsh_sharedobj_kind_t;
 
 /**
- * Kind of protected operation
- */
-typedef enum {FRSH_CSOK_UNBOUNDED, FRSH_CSOK_READ, FRSH_CSOK_WRITE} frsh_csect_op_kind_t;                           
+ * Kind of protected operation: read, write or unchecked
+ **/
+typedef enum 
+  {FRSH_CSOK_UNCHECKED, FRSH_CSOK_READ, FRSH_CSOK_WRITE} 
+frsh_csect_op_kind_t;                           
 
 /**
  *  Pointer to protected operation, which takes a pointer to
@@ -125,7 +129,9 @@ typedef struct {
   void * area;
 } frsh_memory_area_data_t;
 
-/** Memory areas container **/
+/** 
+ * Memory areas container 
+ **/
 typedef struct {
     int size; // = 0
     frsh_memory_area_data_t memory_areas[FRSH_MAX_N_MEMORY_AREAS];
@@ -133,18 +139,17 @@ typedef struct {
 
 
 /**
- * Critical section data (opaque type) 
+ * Critical section data (opaque type)
  **/
-typedef FRSH_CSECT_T_OPAQUE 
-        frsh_csect_t;
+typedef FRSH_CSECT_T_OPAQUE frsh_csect_t;
 
 
 /**
- * Critical section container 
+ * Container of a group of critical sections, up to a maximum size
  **/
 typedef struct {
-    int size; // = 0
-    frsh_csect_t csects[FRSH_MAX_N_CRITICAL_SECTIONS];
+  int size;     // size of the group; initially=0
+  frsh_csect_t csects[FRSH_MAX_N_CRITICAL_SECTIONS]; // array of csect 
 } frsh_csects_group_t;
 
 /*@}*/