Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 2005 - 2006 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
* 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);
* 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
* 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,
*
* 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,
SilcBool connected,
SilcSchedule schedule);
-/****f* silcutil/SilcSocketStreamAPI/silc_socket_stream_get_info
+/****f* silcutil/SilcSocketStreamAPI/silc_socket_stream_is_udp
*
* SYNOPSIS
*
* 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);