X-Git-Url: http://git.silcnet.org/gitweb/?p=website.git;a=blobdiff_plain;f=docs%2Ftoolkit%2Fmanual%2Fsilcpacket-silc_packet_wait.html;fp=docs%2Ftoolkit%2Fmanual%2Fsilcpacket-silc_packet_wait.html;h=265c1306a20ad5367725a5ba2f03a07c376119fa;hp=0000000000000000000000000000000000000000;hb=80b80cef93d9dff6acc4bc8e3a522c55fcdc3fca;hpb=43e53f529ca5c7d2ddb7cee8e76e273631e6f1e2 diff --git a/docs/toolkit/manual/silcpacket-silc_packet_wait.html b/docs/toolkit/manual/silcpacket-silc_packet_wait.html new file mode 100644 index 0000000..265c130 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_wait.html @@ -0,0 +1,299 @@ + + + + + + + + + + + + + + + + + + + +
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_packet_wait

+ + +SYNOPSIS + +

+    int silc_packet_wait(void *waiter, int timeout,
+                         SilcPacket *return_packet)
+
+
+DESCRIPTION + +

+    A special function that can be used to wait for a packet to arrive.
+    This function will block the calling process or thread until either
+    a packet is received into the `return_packet' pointer or the specified
+    timeout value `timeout', which is in milliseconds, will expire.  If
+    the timeout is 0, no timeout exist.  Before calling this function the
+    silc_packet_wait_init must be called.  The caller is responsible for
+    freeing the returned packet with silc_packet_free.
+
+    This function can be used for example from a thread that wants to
+    block until SILC packet has been received.
+
+    Returns 1 when packet was received, 0 if timeout occurred and -1 if
+    error occurred.
+
+
+EXAMPLE + +

+    static int foo_read_data(FooContext c)
+    {
+      SilcPacket packet;
+      void *waiter;
+      ...
+
+      // Will wait for private message packets
+      if (c->initialized == FALSE) {
+        waiter = silc_packet_wait_init(stream,
+                                       SILC_PACKET_PRIVATE_MESSAGE, -1);
+        c->initialized = TRUE;
+      }
+
+      ...
+      // Wait here until private message packet is received
+      if ((silc_packet_wait(waiter, 0, &packet)) < 0)
+        return -1;
+
+      ... process packet ...
+
+      return 1;
+    }
+
+
+



+
+
+ + + + +
+
+ +SILC Packet Engine Interface
+SilcPacketType
+SilcPacketFlags
+SilcPacketEngine
+SilcPacketStream
+SilcPacket
+SilcPacketError
+SilcPacketReceiveCb
+SilcPacketEosCb
+SilcPacketErrorCb
+SilcPacketCallbacks
+silc_packet_engine_start
+silc_packet_engine_stop
+silc_packet_error_string
+silc_packet_engine_get_streams
+silc_packet_engine_free_streams_list
+silc_packet_stream_create
+silc_packet_stream_add_remote
+silc_packet_stream_inject
+silc_packet_stream_destroy
+silc_packet_stream_is_valid
+silc_packet_stream_set_router
+silc_packet_stream_set_iv_included
+silc_packet_stream_set_stream
+silc_packet_stream_get_stream
+silc_packet_stream_link
+silc_packet_stream_unlink
+SilcPacketWrapCoder
+silc_packet_stream_wrap
+silc_packet_stream_is_udp
+silc_packet_get_sender
+silc_packet_stream_ref
+silc_packet_stream_unref
+silc_packet_get_engine
+silc_packet_set_context
+silc_packet_get_context
+silc_packet_set_keys
+silc_packet_get_keys
+silc_packet_set_ids
+silc_packet_get_ids
+silc_packet_set_sid
+silc_packet_send
+silc_packet_send_ext
+silc_packet_send_va
+silc_packet_send_va_ext
+silc_packet_wait_init
+silc_packet_wait_uninit
+silc_packet_wait
+silc_packet_free
+
+ +



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