]> rtime.felk.cvut.cz Git - frescor/forb.git/commitdiff
forb: Update documentation of forb_request_send()
authorMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 24 Feb 2011 13:47:28 +0000 (14:47 +0100)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 24 Feb 2011 13:47:28 +0000 (14:47 +0100)
src/iop.c

index 39fabb49afde43fce384bf47e845569a78257a4b..dc1aa23a4155925700c6991d0dab38316f7cc979 100644 (file)
--- a/src/iop.c
+++ b/src/iop.c
@@ -711,11 +711,13 @@ void *forb_iop_discovery_thread(void *arg)
 }
 
 /** 
- * Sends REQUEST message to another FORB.
+ * Sends REQUEST to another object.
  *
- * The request @a req has to be prepared by
- * forb_iop_prepare_request(). Then, this function adds a message
- * header, connects to the destination FORB and sends the request.
+ * The request @a req has to be prepared previously by calling
+ * forb_iop_prepare_request(). Then, when the request destination is
+ * remote, this function adds a message header, connects to the
+ * destination FORB and sends the request. In the case of local
+ * request, it is directly enqueued into the executor's queue.
  *
  * If no exception is reported, then the caller must wait for response
  * by calling forb_wait_for_reply().