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
*
* SYNOPSIS
*
- * typedef bool (*SilcAsyncOperationPause)(SilcAsyncOperation op,
- * bool pause_operation,
- * void *context);
+ * typedef SilcBool (*SilcAsyncOperationPause)(SilcAsyncOperation op,
+ * SilcBool pause_operation,
+ * void *context);
*
* DESCRIPTION
*
* 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
*
* SYNOPSIS
*
- * bool silc_async_halt(SilcAsyncOperation op);
+ * SilcBool silc_async_halt(SilcAsyncOperation op);
*
* DESCRIPTION
*
* 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
*
* asynchronous operation.
*
***/
-bool silc_async_resume(SilcAsyncOperation op);
+SilcBool silc_async_resume(SilcAsyncOperation op);
/****f* silcutil/SilcAsyncOperationAPI/silc_async_abort
*
*
* 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
*
* 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
* 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
*