Async Operation Interface Atomic Operations Interface Base64 Interface Bit Operations Interface Buffer Interface Buffer Stream Interface Buffer Format Interface Condition Variable Interface Config File Interface Directory Interface Dynamic List Interface Shared Object Interface Environment Interface Errno Interface SilcExampleAPI Fd Stream Interface File Util Interface Finite State Machine GetOpt Interface Global Variable Interface Hash Table Interface HTTP PHP Translator HTTP Server Interface List Interface Local Network Stream Interface Logging Interface Memory Interface MIME Interface Mutex Interface Network Interface Random Number Interface Regex Interface Runtime Toolkit Interface Scheduler Interface Snprintf Interface Socket Stream Interface Memory Pool Interface Stream Interface Stringprep Interface String Utilities Thread Interface Thread Queue Interface Time Interface Timer Interface Binary Search Tree Interface Types and Definitions UTF-8 Interface Misc Utilities XML Interface

Async Operation Interface

DESCRIPTION

SILC Async Operation API is an interface that can be used to control asynchronous operations. All functions that take callback as argument should return SilcAsyncOperation context. That context then can be used to control, such as, abort the asynchronous operation. Using SILC Async Operation API, asynchronous functions can be controlled and aborted safely.

The SILC Async Operation API is divided in two levels; the underlaying operation level that implements the asynchronous operation, and the upper layer that can control the asynchronous operation. The operation layer must guarantee that if the upper layer aborts the asynchronous 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;
 }

TABLE OF CONTENTS

• SilcAsyncOperation
• SilcAsyncOperationStruct
• SilcAsyncOperationAbort
• SilcAsyncOperationPause
• silc_async_halt
• silc_async_resume
• silc_async_abort
• silc_async_alloc
• silc_async_init
• silc_async_free
• silc_async_get_context