SILC Runtime Toolkit 1.2 Beta 1

[runtime.git] / lib / silcutil / silcasync.h

diff --git a/lib/silcutil/silcasync.h b/lib/silcutil/silcasync.h
index 650419a836646fac93a9cbf448817373a390ae2c..d146335456407af1188fa77769b5284fd37094cd 100644 (file)
--- a/lib/silcutil/silcasync.h
+++ b/lib/silcutil/silcasync.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 2005 Pekka Riikonen
+  Copyright (C) 2005 - 2008 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silcutil/SILC Async Operation Interface
+/****h* silcutil/Async Operation Interface
  *
  * DESCRIPTION
  *
@@ -35,12 +35,38 @@
  * operation, no callback function will be called back to the upper layer.
  * This must be remembered when implementing the operation layer.
  *
+ * EXAMPLE
+ *
+ * SilcAsyncOperation async_call(Callback callback, void *cb_context)
+ * {
+ *   SilcAsyncOperation op;
+ *   OpContext ctx;
+ *
+ *   // Allocate async operation so that caller can control us, like abort
+ *   op = silc_async_alloc(async_call_abort, NULL, ctx);
+ *   ctx->callback = callback;
+ *
+ *   ...
+ *
+ *   // Return async operation for upper layer
+ *   return op;
+ * }
+ *
+ * // This callback is called when silc_async_abort is called by upper layer.
+ * // The callback given to async_call must not be called after this.
+ * void async_call_abort(SilcAsyncOperation op, void *context)
+ * {
+ *   OpContext ctx = context;
+ *   ctx->aborted = TRUE;
+ *   ctx->callback = NULL;
+ * }
+ *
  ***/
 
 #ifndef SILCASYNC_H
 #define SILCASYNC_H
 
-/****s* silcutil/SilcAsyncOperationAPI/SilcAsyncOperation
+/****s* silcutil/SilcAsyncOperation
  *
  * NAME
  *
@@ -58,7 +84,7 @@
  ***/
 typedef struct SilcAsyncOperationObject *SilcAsyncOperation;
 
-/****s* silcutil/SilcAsyncOperationAPI/SilcAsyncOperationStruct
+/****s* silcutil/SilcAsyncOperationStruct
  *
  * NAME
  *
@@ -75,7 +101,7 @@ typedef struct SilcAsyncOperationObject *SilcAsyncOperation;
  ***/
 typedef struct SilcAsyncOperationObject SilcAsyncOperationStruct;
 
-/****f* silcutil/SilcAsyncOperationAPI/SilcAsyncOperationAbort
+/****f* silcutil/SilcAsyncOperationAbort
  *
  * SYNOPSIS
  *
@@ -96,13 +122,13 @@ typedef struct SilcAsyncOperationObject SilcAsyncOperationStruct;
 typedef void (*SilcAsyncOperationAbort)(SilcAsyncOperation op,
                                        void *context);
 
-/****f* silcutil/SilcAsyncOperationAPI/SilcAsyncOperationPause
+/****f* silcutil/SilcAsyncOperationPause
  *
  * SYNOPSIS
  *
  *    typedef SilcBool (*SilcAsyncOperationPause)(SilcAsyncOperation op,
- *                                            SilcBool pause_operation,
- *                                            void *context);
+ *                                                SilcBool pause_operation,
+ *                                                void *context);
  *
  * DESCRIPTION
  *
@@ -117,14 +143,14 @@ typedef void (*SilcAsyncOperationAbort)(SilcAsyncOperation op,
  *
  ***/
 typedef SilcBool (*SilcAsyncOperationPause)(SilcAsyncOperation op,
-                                        SilcBool pause_operation,
-                                       void *context);
+                                           SilcBool pause_operation,
+                                           void *context);
 
 /* Upper layer functions for managing asynchronous operations.  Layer
    that has received SilcAsyncOperation context can control the async
    operation with these functions. */
 
-/****f* silcutil/SilcAsyncOperationAPI/silc_async_halt
+/****f* silcutil/silc_async_halt
  *
  * SYNOPSIS
  *
@@ -143,7 +169,7 @@ typedef SilcBool (*SilcAsyncOperationPause)(SilcAsyncOperation op,
  ***/
 SilcBool silc_async_halt(SilcAsyncOperation op);
 
-/****f* silcutil/SilcAsyncOperationAPI/silc_async_resume
+/****f* silcutil/silc_async_resume
  *
  * SYNOPSIS
  *
@@ -161,7 +187,7 @@ SilcBool silc_async_halt(SilcAsyncOperation op);
  ***/
 SilcBool silc_async_resume(SilcAsyncOperation op);
 
-/****f* silcutil/SilcAsyncOperationAPI/silc_async_abort
+/****f* silcutil/silc_async_abort
  *
  * SYNOPSIS
  *
@@ -188,7 +214,7 @@ void silc_async_abort(SilcAsyncOperation op,
 /* The operation layer functions.  The layer that performs the async
    operation use these functions. */
 
-/****f* silcutil/SilcAsyncOperationAPI/silc_async_alloc
+/****f* silcutil/silc_async_alloc
  *
  * SYNOPSIS
  *
@@ -235,14 +261,14 @@ SilcAsyncOperation silc_async_alloc(SilcAsyncOperationAbort abort_cb,
                                    SilcAsyncOperationPause pause_cb,
                                    void *context);
 
-/****f* silcutil/SilcAsyncOperationAPI/silc_async_init
+/****f* silcutil/silc_async_init
  *
  * SYNOPSIS
  *
  *    SilcBool silc_async_init(SilcAsyncOperation op,
- *                         SilcAsyncOperationAbort abort_cb,
- *                         SilcAsyncOperationPause pause_cb,
- *                         void *context);
+ *                             SilcAsyncOperationAbort abort_cb,
+ *                             SilcAsyncOperationPause pause_cb,
+ *                             void *context);
  *
  * DESCRIPTION
  *
@@ -251,7 +277,8 @@ SilcAsyncOperation silc_async_alloc(SilcAsyncOperationAbort abort_cb,
  *    layer to abort the asynchronous operation, by calling the
  *    silc_async_abort.  Since this use pre-allocated context, the function
  *    silc_async_free need not be called.  This function is equivalent
- *    to silc_async_alloc except this does not allocate any memory.
+ *    to silc_async_alloc except this does not allocate any memory.  The `op'
+ *    needs not be uninitialized.  This returns always TRUE.
  *
  *    If the `pause_cb' is provided then the upper layer may also halt and
  *    then later resume the execution of the operation, by calling the
@@ -260,11 +287,11 @@ SilcAsyncOperation silc_async_alloc(SilcAsyncOperationAbort abort_cb,
  *
  ***/
 SilcBool silc_async_init(SilcAsyncOperation op,
-                    SilcAsyncOperationAbort abort_cb,
-                    SilcAsyncOperationPause pause_cb,
-                    void *context);
+                        SilcAsyncOperationAbort abort_cb,
+                        SilcAsyncOperationPause pause_cb,
+                        void *context);
 
-/****f* silcutil/SilcAsyncOperationAPI/silc_async_free
+/****f* silcutil/silc_async_free
  *
  * SYNOPSIS
  *
@@ -283,7 +310,7 @@ SilcBool silc_async_init(SilcAsyncOperation op,
  ***/
 void silc_async_free(SilcAsyncOperation op);
 
-/****f* silcutil/SilcAsyncOperationAPI/silc_async_get_context
+/****f* silcutil/silc_async_get_context
  *
  * SYNOPSIS
  *