X-Git-Url: http://git.silcnet.org/gitweb/?p=website.git;a=blobdiff_plain;f=docs%2Ftoolkit%2Fmanual%2Fsilcasync-silc_async_alloc.html;fp=docs%2Ftoolkit%2Fmanual%2Fsilcasync-silc_async_alloc.html;h=6834ab58e462e2635ea4caaeb05f19a4eb82f020;hp=0000000000000000000000000000000000000000;hb=80b80cef93d9dff6acc4bc8e3a522c55fcdc3fca;hpb=43e53f529ca5c7d2ddb7cee8e76e273631e6f1e2 diff --git a/docs/toolkit/manual/silcasync-silc_async_alloc.html b/docs/toolkit/manual/silcasync-silc_async_alloc.html new file mode 100644 index 0000000..6834ab5 --- /dev/null +++ b/docs/toolkit/manual/silcasync-silc_async_alloc.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
Copyright © 2001 - 2007 SILC Project
+ SILC Project Website
+ SILC Toolkit Reference Manual
+ Index
+ + +
+ + + + + + + + + + + + + + +
+ + + +
+
+ + + +SILC Toolkit Reference Manual
+ + +SILC Crypto Library
+    Introduction to SILC RNG
+    SILC RNG Interface
+    SILC Cipher API
+    SILC PKCS API
+    SILC Public Key API
+    SILC PKCS #1 API
+    SILC Hash Interface
+    SILC HMAC Interface
+SILC Core Library
+    SILC Authentication Interface
+    SILC Message Interface
+    SILC Channel Interface
+    SILC Command Interface
+    SILC Notify Interface
+    SILC Status Types
+    SILC Modes
+    SILC ID Interface
+    SILC Argument Interface
+    SILC Attributes Interface
+    Packet Engine Interface
+    SILC Public Key Payload Interface
+SILC Key Exchange Library
+    SILC SKE Interface
+    SILC Connection Authentication Interface
+SILC VCard Library
+    SILC VCard Interface
+SILC Math Library
+    SILC MP Interface
+    SILC Math Interface
+SILC Client Library
+    Using SILC Client Library Tutorial
+    Arguments for command_reply Client Operation
+    SilcStatus Error Arguments in command_reply Client Operation
+    Arguments for notify Client Operation
+    Unicode and UTF-8 Strings in Client Library
+    Client Library Interface Reference
+    Client Entry Interface Reference
+SILC ASN.1 Library
+    SILC ASN.1 Interface
+    SILC BER interface
+SILC HTTP Library
+    SILC HTTP Server Interface
+    SILC HTTP PHP Translator
+SILC Utility Library
+    Basic Types and Definitions
+    Data Buffer Interface
+    Data Buffer Format Interface
+    Hash Table Interface
+    Memory Allocation Interface
+    Data Stack (memory pool) Interface
+    Finite State Machine Interface
+    Thread Interface
+    Mutual Exclusion Lock Interface
+    Condition Variable Interface
+    Atomic Operations Interface
+    Network (TCP and UDP) Interface
+    Scheduler Interface
+    Asynchronous Operation Interface
+    Abstract Stream Interface
+    Socket Stream Interface
+    File Descriptor Stream Interface
+    File Utility Functions
+    String Utility Interface
+    Snprintf Interface
+    UTF-8 String Interface
+    Stringprep Interface
+    Utility Functions
+    List Interface
+    Dynamic List Interface
+    MIME Interface
+    Time Utility Functions
+    Logging Interface
+    Config File Interface
+SILC Key Repository Library
+    SILC SKR Interface
+SILC Application Utility Library
+    SILC Application Utilities
+    SILC ID Cache Interface
+SILC SFTP Library
+    SILC SFTP Interface
+    SFTP Filesystems Interface
+ +
+Resource Links +
+SILC Project Website
+SILC Protocol Documentation
+SILC White Paper
+SILC FAQs
+ +
+



+
+
+ + + + +
+
+ +Function silc_async_alloc

+ + +SYNOPSIS + +

+    SilcAsyncOperation silc_async_alloc(SilcAsyncOperationAbort abort_cb,
+                                        SilcAsyncOperationPause pause_cb,
+                                        void *context);
+
+
+DESCRIPTION + +

+    Start asynchronous operation, and assign `abort_cb' callback for it,
+    which can be used by some upper layer to abort the asynchronous
+    operation, by calling the silc_async_abort.  The layer which calls
+    this function must also call silc_async_free when the asynchronous
+    operation is successfully completed.  If it is aborted by upper layer
+    then silc_async_free must not be called, since it is called by the
+    silc_async_abort function.
+
+    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
+    silc_async_halt and silc_async_resume respectively.  If `pause_cb' is
+    not provided then these functions has no effect for this operation.
+
+
+EXAMPLE + +

+    SilcAsyncOperation silc_async_call(Callback callback, void *cb_context)
+    {
+      SilcAsyncOperation op;
+      ...
+
+      // Allocate async operation so that caller can control us, like abort
+      op = silc_async_alloc(silc_async_call_abort, NULL, ctx);
+
+      // Start async operation in FSM
+      silc_fsm_init(&ctx->fsm, ctx, fsm_destructor, ctx, schedule);
+      silc_fsm_start(&ctx->fsm, first_state);
+      ...
+
+      // Return async operation for upper layer
+      return op;
+    }
+
+
+



+
+
+ + + + +
+
+ +SILC Async Operation Interface
+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
+
+ +



+
+
+ + + +
+ + + + + + +
Copyright © 2001 - 2007 SILC Project
+ SILC Project Website
+ SILC Toolkit Reference Manual
+ Index
+ + +