Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove from the public interface a function that the user should never call
[simgrid.git] / src / gras / Msg / msg_private.h
index 7e36382..7b03a7a 100644 (file)
@@ -4,20 +4,18 @@
 
 /* module's private interface masked even to other parts of GRAS.           */
 
-/* Authors: Martin Quinson                                                  */
-/* Copyright (C) 2003, 2004 Martin Quinson.                                 */
+/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
 
 /* This program is free software; you can redistribute it and/or modify it
  under the terms of the license (GNU LGPL) which comes with this package. */
* under the terms of the license (GNU LGPL) which comes with this package. */
 
 #ifndef GRAS_MESSAGE_PRIVATE_H
 #define GRAS_MESSAGE_PRIVATE_H
 
-#include "gras_config.h"
+#include "portable.h"
 
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
-#include "xbt/error.h"
 #include "xbt/dynar.h"
 #include "xbt/set.h"
 #include "gras/transport.h"
 #include "gras/virtu.h"
 
 #include "gras/messages.h"
+#include "gras/timer.h"
 #include "gras_modinter.h"
 
 #include "gras/Msg/msg_interface.h"
 
+extern char _GRAS_header[6];
+
+extern int gras_msg_libdata_id; /* The identifier of our libdata */
+extern const char *e_gras_msg_kind_names[e_gras_msg_kind_count];
+
+/* declare either regular messages or RPC or whatever */
+XBT_PUBLIC void 
+gras_msgtype_declare_ext(const char           *name,
+                        short int             version,
+                        e_gras_msg_kind_t     kind, 
+                        gras_datadesc_type_t  payload_request,
+                        gras_datadesc_type_t  payload_answer);
+
 /**
  * gras_msgtype_t:
  *
  * Message type descriptor. There one of these for each registered version.
  */
-struct s_gras_msgtype {
+typedef struct s_gras_msgtype {
   /* headers for the data set */
   unsigned int   code;
   char          *name;
@@ -42,17 +55,23 @@ struct s_gras_msgtype {
         
   /* payload */
   short int version;
-  gras_datadesc_type_t *ctn_type;
-};
+  e_gras_msg_kind_t kind;
+  gras_datadesc_type_t ctn_type;
+  gras_datadesc_type_t answer_type; /* only used for RPC */
+} s_gras_msgtype_t;
 
-extern gras_set_t *_gras_msgtype_set; /* of gras_msgtype_t */
+extern xbt_set_t _gras_msgtype_set; /* of gras_msgtype_t */
 void gras_msgtype_free(void *msgtype);
 
 
-gras_error_t gras_msg_recv(gras_socket_t   *sock,
-                          gras_msgtype_t **msgtype,
-                          void           **payload,
-                          int             *payload_size);
+/* functions to extract msg from socket or put it on wire (depend RL vs SG) */
+XBT_PUBLIC void gras_msg_recv(gras_socket_t   sock,
+                  gras_msg_t      msg/*OUT*/);
+XBT_PUBLIC void gras_msg_send_ext(gras_socket_t   sock,
+                    e_gras_msg_kind_t kind,
+                      unsigned long int ID,
+                      gras_msgtype_t  msgtype,
+                      void           *payload);
 
 /**
  * gras_cblist_t:
@@ -61,9 +80,45 @@ gras_error_t gras_msg_recv(gras_socket_t   *sock,
  */
 struct s_gras_cblist {
   long int id;
-  gras_dynar_t *cbs; /* of gras_msg_cb_t */
+  xbt_dynar_t cbs; /* of gras_msg_cb_t */
+};
+
+typedef struct s_gras_cblist gras_cblist_t;
+XBT_PUBLIC void gras_cbl_free(void *); /* used to free the memory at the end */
+XBT_PUBLIC void gras_cblist_free(void *cbl);
+
+/**
+ * gras_msg_cb_ctx_t:
+ *
+ * Context associated to a given callback (to either regular message or RPC)
+ */
+struct s_gras_msg_cb_ctx {
+  gras_socket_t expeditor;
+  gras_msgtype_t msgtype;
+  unsigned long int ID;
+  double timeout;
+  int answer_due; /* Whether the callback is expected to return a result (for sanity checks) */
 };
+typedef struct s_gras_msg_cb_ctx s_gras_msg_cb_ctx_t;
+
+/* ********* *
+ * * TIMER * *
+ * ********* */
+typedef struct {
+  double expiry;
+  double period;
+  void_f_void_t *action;
+  int repeat;
+} s_gras_timer_t, *gras_timer_t;
+
+/* returns 0 if it handled a timer, or the delay until next timer, or -1 if no armed timer */
+XBT_PUBLIC double gras_msg_timer_handle(void);
+
+XBT_PUBLIC gras_msg_cb_ctx_t gras_msg_cb_ctx_new(gras_socket_t expe,
+                                                gras_msgtype_t msgtype,
+                                                unsigned long int ID,
+                                                int answer_due,
+                                                double timeout);
 
-void gras_cblist_free(void *cbl);
 
 #endif  /* GRAS_MESSAGE_PRIVATE_H */