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

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

diff --git a/lib/silcutil/silcsocketstream.h b/lib/silcutil/silcsocketstream.h
index 4d4acec73878d6351a836d062e93483586d09076..e9fd435782959fd2e3298047571d4c2c77e9e3bb 100644 (file)
--- a/lib/silcutil/silcsocketstream.h
+++ b/lib/silcutil/silcsocketstream.h
@@ -78,6 +78,9 @@ typedef enum {
  *    functions can also be used to read data, send data, and otherwise
  *    handle the stream.
  *
+ *    If the silc_stream_set_notifier is called the stream will be set to
+ *    non-blocking mode.
+ *
  ***/
 typedef void (*SilcSocketStreamCallback)(SilcSocketStreamStatus status,
                                         SilcStream stream, void *context);
@@ -102,7 +105,7 @@ typedef void (*SilcSocketStreamCallback)(SilcSocketStreamStatus status,
  *    socket connection information, such as hostname and IP address are
  *    resolved, so SilcAsyncOperation is returned which can be used to cancel
  *    the creation process.  The `callback' will be called to return the
- *    created socket stream.  To destroy the stream call silc_stream_destroy.
+ *    created socket stream.
  *
  *    If the `lookup' is TRUE then this will perform IP and hostname lookup
  *    for the socket.  If the `require_fqdn' is TRUE then the socket must
@@ -112,6 +115,9 @@ typedef void (*SilcSocketStreamCallback)(SilcSocketStreamStatus status,
  *    will not be available from the socket stream.  In that case this will
  *    also return NULL as the `callback' is called immediately.
  *
+ *    If the silc_stream_set_notifier is called the stream is set to
+ *    non-blocking mode.
+ *
  ***/
 SilcAsyncOperation
 silc_socket_tcp_stream_create(SilcSocket sock, SilcBool lookup,
@@ -152,6 +158,9 @@ silc_socket_tcp_stream_create(SilcSocket sock, SilcBool lookup,
  *
  *    This function returns the created SilcStream or NULL on error.
  *
+ *    If the silc_stream_set_notifier is called the stream is set to
+ *    non-blocking mode.
+ *
  ***/
 SilcStream silc_socket_udp_stream_create(SilcSocket sock,
                                         SilcBool ipv6,
@@ -168,10 +177,11 @@ SilcStream silc_socket_udp_stream_create(SilcSocket sock,
  * DESCRIPTION
  *
  *    Returns TRUE if the `stream' is UDP stream.  If the `connected' pointer
- *    is non-NULL indication whether the UDP stream is in connected state.
- *    If it is then packets can be read and written using silc_stream_read
- *    and silc_stream_write.  If it is not then packets need to read and
- *    written by using silc_net_udp_receive and silc_net_udp_send.
+ *    is non-NULL it will have indication whether the UDP stream is in
+ *    connected state.  If it is then packets can be read and written using
+ *    silc_stream_read and silc_stream_write.  If it is not then packets
+ *    need to read and written by using silc_net_udp_receive and
+ *    silc_net_udp_send.
  *
  ***/
 SilcBool silc_socket_stream_is_udp(SilcStream stream, SilcBool *connected);