Prepared for multiple executors in a single address space

[frescor/forb.git] / src / request.h

diff --git a/src/request.h b/src/request.h
index a5ab8caa76ca2fa192982bbb01d7515a5d6beb29..16f9049ed4d4c8f8adf0b837dfe80acaf3712d73 100644 (file)
--- a/src/request.h
+++ b/src/request.h
@@ -47,25 +47,39 @@
 #ifndef REQUEST_H
 #define REQUEST_H
 
-#include <forb/forb.h>
+/**
+ * @file   request.h
+ * @author Michal Sojka <sojkam1@fel.cvut.cz>
+ * @date   Sun Oct 12 15:50:30 2008
+ * 
+ * @brief  Data type and functions for manipulation with requests.
+ * 
+ * 
+ */
+
+
+#include <forb.h>
 #include <forb/cdr.h>
 #include <forb/basic_types.h>
 #include <forb/syncobj.h>
 #include <ul_gavlcust.h>
 #include <forb/forb-internal.h>
 
+
 /**
  * Helper structure for sending ORB requests.
  *
- * It is allocated in stub's stack.
+ * Its purpose is to match incomming reply messages to previously sent
+ * requests. It is allocated in stub's stack and during waiting for
+ * reply is stored in forb_t::requests tree.
  * 
  */
 struct forb_request {
-       CORBA_unsigned_long request_id;
-       CDR_Codec cdr_request;
-       CDR_Codec *cdr_reply;
-       gavl_node_t node;
-       forb_object obj;
+       CORBA_unsigned_long request_id; /**< Numeric ID of this request. Used to match replies agains this request. */
+       FORB_CDR_Codec cdr_request;     /**< Buffer for the request serialization. */
+       FORB_CDR_Codec *cdr_reply;      /**< Buffer with received reply. */
+       gavl_node_t node;       /**< forb_t::requests node */
+       forb_object obj;        /**< Object being requested. */
        struct forb_env *env;   /**< Where to store exception returned in reply */
        forb_syncobj_t reply_ready; /**< Synchronization object for waiting for reply */
        forb_syncobj_t *reply_processed; /**< Synchronization object for receiver thread to wait for stub. */
@@ -119,8 +133,5 @@ void
 forb_request_wait_for_reply(forb_request_t *req);
 void
 forb_request_signal_processed(forb_request_t *req);
-void
-forb_request_send(forb_request_t *req, CORBA_Environment *env);
-
 
 #endif