Merge branch 'topic/mm-fixes' of git://208.110.73.182/silc into silc.1.1.branch

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

diff --git a/lib/silcutil/silcasync.h b/lib/silcutil/silcasync.h
index b60c2b97c3ab0f3f802e715e8ee5258a40d1ad68..2853e9c3d0f02ab79cb3acea7d88f7ed8a924219 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 - 2007 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
@@ -100,9 +100,9 @@ typedef void (*SilcAsyncOperationAbort)(SilcAsyncOperation op,
  *
  * SYNOPSIS
  *
- *    typedef bool (*SilcAsyncOperationPause)(SilcAsyncOperation op,
- *                                            bool pause_operation,
- *                                            void *context);
+ *    typedef SilcBool (*SilcAsyncOperationPause)(SilcAsyncOperation op,
+ *                                                SilcBool pause_operation,
+ *                                                void *context);
  *
  * DESCRIPTION
  *
@@ -116,9 +116,9 @@ typedef void (*SilcAsyncOperationAbort)(SilcAsyncOperation op,
  *    was (or is going to be) halted or resumed, and FALSE on error.
  *
  ***/
-typedef bool (*SilcAsyncOperationPause)(SilcAsyncOperation op,
-                                        bool pause_operation,
-                                       void *context);
+typedef SilcBool (*SilcAsyncOperationPause)(SilcAsyncOperation op,
+                                           SilcBool pause_operation,
+                                           void *context);
 
 /* Upper layer functions for managing asynchronous operations.  Layer
    that has received SilcAsyncOperation context can control the async
@@ -128,7 +128,7 @@ typedef bool (*SilcAsyncOperationPause)(SilcAsyncOperation op,
  *
  * SYNOPSIS
  *
- *    bool silc_async_halt(SilcAsyncOperation op);
+ *    SilcBool silc_async_halt(SilcAsyncOperation op);
  *
  * DESCRIPTION
  *
@@ -141,13 +141,13 @@ typedef bool (*SilcAsyncOperationPause)(SilcAsyncOperation op,
  *    controls the asynchronous operation.
  *
  ***/
-bool silc_async_halt(SilcAsyncOperation op);
+SilcBool silc_async_halt(SilcAsyncOperation op);
 
 /****f* silcutil/SilcAsyncOperationAPI/silc_async_resume
  *
  * SYNOPSIS
  *
- *    bool silc_async_resume(SilcAsyncOperation op);
+ *    SilcBool silc_async_resume(SilcAsyncOperation op);
  *
  * DESCRIPTION
  *
@@ -159,7 +159,7 @@ bool silc_async_halt(SilcAsyncOperation op);
  *    asynchronous operation.
  *
  ***/
-bool silc_async_resume(SilcAsyncOperation op);
+SilcBool silc_async_resume(SilcAsyncOperation op);
 
 /****f* silcutil/SilcAsyncOperationAPI/silc_async_abort
  *
@@ -239,10 +239,10 @@ SilcAsyncOperation silc_async_alloc(SilcAsyncOperationAbort abort_cb,
  *
  * SYNOPSIS
  *
- *    bool silc_async_init(SilcAsyncOperation op,
- *                         SilcAsyncOperationAbort abort_cb,
- *                         SilcAsyncOperationPause pause_cb,
- *                         void *context);
+ *    SilcBool silc_async_init(SilcAsyncOperation op,
+ *                             SilcAsyncOperationAbort abort_cb,
+ *                             SilcAsyncOperationPause pause_cb,
+ *                             void *context);
  *
  * DESCRIPTION
  *
@@ -251,7 +251,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.
  *
  *    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
@@ -259,10 +260,10 @@ SilcAsyncOperation silc_async_alloc(SilcAsyncOperationAbort abort_cb,
  *    not provided then these functions has no effect for this operation.
  *
  ***/
-bool silc_async_init(SilcAsyncOperation op,
-                    SilcAsyncOperationAbort abort_cb,
-                    SilcAsyncOperationPause pause_cb,
-                    void *context);
+SilcBool silc_async_init(SilcAsyncOperation op,
+                        SilcAsyncOperationAbort abort_cb,
+                        SilcAsyncOperationPause pause_cb,
+                        void *context);
 
 /****f* silcutil/SilcAsyncOperationAPI/silc_async_free
  *