5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 2005 - 2007 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; version 2 of the License.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
20 /****h* silcutil/SILC Socket Stream Interface
24 * Implementation of SILC Socket Stream. SILC Socket Stream can be used
25 * read data from and write data to a socket connection. The SILC Socket
26 * Stream provides also Quality of Service (QoS) support that can be used
27 * to control the throughput of the stream. It also supports both TCP and
28 * UDP, and IPv4 and IPv6.
30 * SILC Socket Stream is not thread-safe. If the same socket stream must be
31 * used in multithreaded environment concurrency control must be employed.
35 #ifndef SILCSOCKETSTREAM_H
36 #define SILCSOCKETSTREAM_H
38 /****f* silcutil/SilcSocketStreamAPI/SilcSocketStreamCallback
42 * typedef void (*SilcSocketStreamCallback)(SilcResult status,
48 * Callback function of this type is called after the socket stream
49 * creation is completed. If the `stream' is NULL the socket stream could
50 * not be created or the socket connection is not otherwise allowed. The
51 * `status' will indicate the error status. In case error ocurrs the
52 * associated socket has already been destroyed. The `stream' is socket
53 * stream representing the socket connection and silc_socket_stream_*
54 * functions can be used to access the stream. All other silc_stream_*
55 * functions can also be used to read data, send data, and otherwise
58 * If the silc_stream_set_notifier is called the stream will be set to
62 typedef void (*SilcSocketStreamCallback)(SilcResult status,
63 SilcStream stream, void *context);
65 /****f* silcutil/SilcSocketStreamAPI/silc_socket_tcp_stream_create
70 * silc_socket_tcp_stream_create(SilcSocket sock, SilcBool lookup,
71 * SilcBool require_fqdn,
72 * SilcSchedule schedule,
73 * SilcSocketStreamCallback callback,
78 * Creates TCP socket stream of the TCP connection indicated by `sock'.
79 * The stream can be destroyed by calling the silc_stream_destroy. Data
80 * can be sent and received from the stream by calling silc_stream_write
81 * and silc_stream_read. The creation process is asynchronous since
82 * socket connection information, such as hostname and IP address are
83 * resolved, so SilcAsyncOperation is returned which can be used to cancel
84 * the creation process. The `callback' will be called to return the
85 * created socket stream.
87 * If the `lookup' is TRUE then this will perform IP and hostname lookup
88 * for the socket. If the `require_fqdn' is TRUE then the socket must
89 * have valid hostname and IP address, otherwise the stream creation will
90 * fail. If it is FALSE then only valid IP address is required. Note that,
91 * if the `lookup' is FALSE then the hostname, IP and port information
92 * will not be available from the socket stream. In that case this will
93 * also return NULL as the `callback' is called immediately.
95 * If the silc_stream_set_notifier is called the stream is set to
100 silc_socket_tcp_stream_create(SilcSocket sock, SilcBool lookup,
101 SilcBool require_fqdn,
102 SilcSchedule schedule,
103 SilcSocketStreamCallback callback,
106 /****f* silcutil/SilcSocketStreamAPI/silc_socket_udp_stream_create
110 * SilcStream silc_socket_udp_stream_create(SilcSocket sock,
112 * SilcBool connected,
113 * SilcSchedule schedule);
117 * Creates UDP socket stream of the UDP connection indicated by `sock'.
118 * The stream can be destroyed by calling the silc_stream_destroy.
119 * The `connected' defines whether the socket is in connected or in
120 * connectionless state.
122 * Note that, UDP packets may be read only through the notifier
123 * callback (see silc_stream_set_notifier), when SILC_STREAM_CAN_READ
124 * is returned to the callback. Because of this the notifier callback
127 * Note that, UDP packet sending using silc_stream_write and receiving
128 * with silc_stream_read works only if the `sock' is a UDP socket in a
129 * connected state. In connectionless state sending packets with
130 * silc_stream_write is possible only if the remote address and port
131 * has been set with silc_socket_stream_set_info. If it is not set
132 * in connectionless state packets may be sent only by using the
133 * silc_net_udp_send function. In connectionless state packets may be
134 * received only by using silc_net_udp_receive.
136 * This function returns the created SilcStream or NULL on error.
138 * If the silc_stream_set_notifier is called the stream is set to
142 SilcStream silc_socket_udp_stream_create(SilcSocket sock,
145 SilcSchedule schedule);
147 /****f* silcutil/SilcSocketStreamAPI/silc_socket_stream_is_udp
151 * SilcBool silc_socket_stream_is_udp(SilcStream stream,
152 * SilcBool *connected);
156 * Returns TRUE if the `stream' is UDP stream. If the `connected' pointer
157 * is non-NULL it will have indication whether the UDP stream is in
158 * connected state. If it is then packets can be read and written using
159 * silc_stream_read and silc_stream_write. If it is not then packets
160 * need to read and written by using silc_net_udp_receive and
164 SilcBool silc_socket_stream_is_udp(SilcStream stream, SilcBool *connected);
166 /****f* silcutil/SilcSocketStreamAPI/silc_socket_stream_get_info
171 * silc_socket_stream_get_info(SilcStream stream,
172 * SilcSocket *sock, const char **hostname,
173 * const char **ip, SilcUInt16 *port);
177 * Returns socket stream information such as the socket, remote hostname,
178 * remote IP address and the remote port of the remote socket connection.
179 * Return FALSE if these informations are not available.
182 SilcBool silc_socket_stream_get_info(SilcStream stream,
183 SilcSocket *sock, const char **hostname,
184 const char **ip, SilcUInt16 *port);
186 /****f* silcutil/SilcSocketStreamAPI/silc_socket_stream_set_info
191 * silc_socket_stream_set_info(SilcStream stream,
192 * const char *hostname,
193 * const char *ip, SilcUInt16 port);
197 * Use this function to set the hostname, IP address and remote port
198 * information to the socket stream indicated by `stream' if you did not
199 * perform lookup in the silc_socket_tcp_stream_create. This is not
200 * mandatory but if you would like to associate the information with the
201 * stream use this function. If the lookup was performed when creating
202 * the stream then calling this function is not necessary. Use the
203 * function silc_socket_stream_get_info to get the information from the
207 SilcBool silc_socket_stream_set_info(SilcStream stream,
208 const char *hostname,
209 const char *ip, SilcUInt16 port);
211 /****f* silcutil/SilcSocketStreamAPI/silc_socket_stream_set_qos
215 * SilcBool silc_socket_stream_set_qos(SilcStream stream,
216 * SilcUInt32 read_rate,
217 * SilcUInt32 read_limit_bytes,
218 * SilcUInt32 limit_sec,
219 * SilcUInt32 limit_usec)
223 * Sets a "Quality of Service" settings for socket stream `stream'.
224 * The `read_rate' specifies the maximum read operations per second.
225 * If more read operations are executed the limit will be applied for
226 * the reading. The `read_limit_bytes' specifies the maximum data
227 * that is read. It is guaranteed that silc_stream_read never returns
228 * more than `read_limit_bytes' of data. The `limit_sec' and `limit_usec'
229 * specifies the time limit that is applied if `read_rate' and/or
230 * `read_limit_bytes' is reached. If all arguments except `stream'
231 * are zero this resets the QoS from the socket stream, all QoS for
232 * this socket stream that may be pending will be cancelled.
235 SilcBool silc_socket_stream_set_qos(SilcStream stream,
236 SilcUInt32 read_rate,
237 SilcUInt32 read_limit_bytes,
238 SilcUInt32 limit_sec,
239 SilcUInt32 limit_usec);
241 #include "silcsocketstream_i.h"
243 #endif /* SILCSOCKETSTREAM_H */