aboutsummaryrefslogtreecommitdiffstats
path: root/src/charon/processing
diff options
context:
space:
mode:
Diffstat (limited to 'src/charon/processing')
-rw-r--r--src/charon/processing/jobs/callback_job.c2
-rw-r--r--src/charon/processing/jobs/callback_job.h13
-rw-r--r--src/charon/processing/processor.h4
3 files changed, 15 insertions, 4 deletions
diff --git a/src/charon/processing/jobs/callback_job.c b/src/charon/processing/jobs/callback_job.c
index 86aa93c6c..53e7caa95 100644
--- a/src/charon/processing/jobs/callback_job.c
+++ b/src/charon/processing/jobs/callback_job.c
@@ -56,7 +56,7 @@ struct private_callback_job_t {
pthread_t thread;
/**
- * mutex to synchronize thread startup/cancellation
+ * mutex to access jobs interna
*/
pthread_mutex_t mutex;
diff --git a/src/charon/processing/jobs/callback_job.h b/src/charon/processing/jobs/callback_job.h
index 5450cb61b..169f2d207 100644
--- a/src/charon/processing/jobs/callback_job.h
+++ b/src/charon/processing/jobs/callback_job.h
@@ -33,6 +33,11 @@ typedef enum job_requeue_t job_requeue_t;
/**
* @brief Job requeueing policy
+ *
+ * The job requeueing policy defines how a job is handled when the callback
+ * function returns.
+ *
+ * @ingroup jobs
*/
enum job_requeue_t {
@@ -42,12 +47,12 @@ enum job_requeue_t {
JOB_REQUEUE_NONE,
/**
- * Reque the job farly, meaning it has to queue as any other job
+ * Reque the job fairly, meaning it has to requeue as any other job
*/
JOB_REQUEUE_FAIR,
/**
- * Reexecute the job directly, without the need of requeing it
+ * Reexecute the job directly, without the need of requeueing it
*/
JOB_REQUEUE_DIRECT,
};
@@ -60,6 +65,8 @@ enum job_requeue_t {
*
* @param data param supplied to job
* @return requeing policy how to requeue the job
+ *
+ * @ingroup jobs
*/
typedef job_requeue_t (*callback_job_cb_t)(void *data);
@@ -72,6 +79,8 @@ typedef job_requeue_t (*callback_job_cb_t)(void *data);
*
* @param data param supplied to job
* @return requeing policy how to requeue the job
+ *
+ * @ingroup jobs
*/
typedef void (*callback_job_cleanup_t)(void *data);
diff --git a/src/charon/processing/processor.h b/src/charon/processing/processor.h
index 6763e27d0..f12c7f10e 100644
--- a/src/charon/processing/processor.h
+++ b/src/charon/processing/processor.h
@@ -98,7 +98,9 @@ struct processor_t {
/**
* @brief Create the thread pool without any threads.
- *
+ *
+ * Use the set_threads method to start processing jobs.
+ *
* @return processor_t object
*
* @ingroup processing