From: Michal Sojka <sojkam1@fel.cvut.cz>
Date: Sat, 15 Nov 2008 17:17:46 +0000 (+0100)
Subject: Added better documentation of executor
X-Git-Url: https://rtime.felk.cvut.cz/gitweb/frescor/forb.git/commitdiff_plain/ea4dd903b98257bb22195700e5fa520b84975188

Added better documentation of executor
---

diff --git a/src/executor.c b/src/executor.c
index ce26d55..dc4a547 100644
--- a/src/executor.c
+++ b/src/executor.c
@@ -115,7 +115,12 @@ void forb_executor_unregister_object(forb_executor_t *executor, forb_object obj)
 }
 
 /** 
- * Executor's main loop which processes requests.
+ * Executor's main loop which executes object implementation methods
+ * upon request.
+ *
+ * The requests are represented by ::forb_exec_req_t and are enqueued
+ * to the executor's request queue by receiver threads of individual
+ * ports (forb_iop_receiver_thread()).
  * 
  * @param executor 
  * 
diff --git a/src/executor.h b/src/executor.h
index 42f73cd..0d08f4f 100644
--- a/src/executor.h
+++ b/src/executor.h
@@ -62,7 +62,13 @@
 
 /**
  * Executor structure.
- * 
+ *
+ * Executors provide a way for applications to determine which thread
+ * will execute requests for a particular object. After the executor
+ * structure is initialized by forb_executor_init(), several objects
+ * can be registered to it by forb_executor_register_object(). Then a
+ * loop which waits for requests and executes them by calling object
+ * implementations is started by forb_executor_run().
  */
 typedef struct forb_executor {
 	fosa_mutex_t mutex;	/**< Mutex for protecting forb_executor_t::requests. */