Added examples to headers.

[crypto.git] / lib / silcutil / silccond.h

diff --git a/lib/silcutil/silccond.h b/lib/silcutil/silccond.h
index 1fe8bb21001512b34086243c48ed8b89ca64c18b..08110d8145b1cbd24c0c1039ffe0c9f34f49cd6f 100644 (file)
--- a/lib/silcutil/silccond.h
+++ b/lib/silcutil/silccond.h
@@ -25,6 +25,25 @@
  * Condition variables enable threads to suspend execution and yield
  * the processors until some predicate on some shared data is satisfied.
  *
+ * EXAMPLE
+ *
+ * Thread 1:
+ *
+ * // Wait for signal
+ * silc_mutex_lock(lock);
+ * while (c->a == NULL)
+ *   silc_cond_wait(cond, lock);
+ * ...
+ * silc_mutex_unlock(lock);
+ *
+ * Thread 2:
+ *
+ * // Signal
+ * silc_mutex_lock(lock);
+ * c->a = context;
+ * silc_cond_signal(cond);
+ * silc_mutex_unlock(lock);
+ *
  ***/
 
 #ifndef SILCCOND_H