5 Author: Pekka Riikonen <priikone@silnet.org>
7 Copyright (C) 1997 - 2001 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; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
21 /****h* silcutil/SILC Socket Interface
25 * Implementation of the Socket Connection object. The SilcSocketConnection
26 * is used by all applications to represent a socket based connection
27 * to the network. The Socket Connection object handles inbound and outbound
28 * data buffers, can perform keepalive actions for the connection and
29 * supports connection based protocols as well.
33 #ifndef SILCSOCKCONN_H
34 #define SILCSOCKCONN_H
36 /****s* silcutil/SilcSocketConnectionAPI/SilcSocketConnection
40 * typedef struct SilcSocketConnectionStruct *SilcSocketConnection;
44 * This context is forward declaration for the SilcSocketConnectionStruct.
45 * This is allocated by the silc_socket_alloc and freed by the
46 * silc_socket_free function. The silc_socket_dup can be used to
47 * increase the reference counter of the context. The data is freed
48 * by the silc_socket_free function only after the reference counter
52 typedef struct SilcSocketConnectionStruct *SilcSocketConnection;
54 /****s* silcutil/SilcSocketConnectionAPI/SilcSocketConnectionHB
58 * typedef struct SilcSocketConnectionHB *SilcSocketConnectionHB;
62 * This context is the heartbeat context for the SilcSockeConnection.
63 * It is meant to hold the keepalive information for the connection.
64 * This is allocated internally and freed internally by the
68 typedef struct SilcSocketConnectionHBStruct *SilcSocketConnectionHB;
70 /****d* silcutil/SilcSocketConnectionAPI/SilcSocketType
74 * typedef enum { ... } SilcSocketType;
78 * Socket types. These identifies the socket connection. There
79 * are four different types; unknown, client, server and router.
80 * Unknown connections are connections that hasn't advanced long
81 * enough so that we might know which type of connection it is.
82 * It is the applications responsibility to update the type
83 * information when it becomes available.
88 SILC_SOCKET_TYPE_UNKNOWN = 0,
89 SILC_SOCKET_TYPE_CLIENT = 1,
90 SILC_SOCKET_TYPE_SERVER = 2,
91 SILC_SOCKET_TYPE_ROUTER = 3
96 #define SILC_SF_NONE 0
97 #define SILC_SF_INBUF_PENDING 1 /* data in inbound buffer */
98 #define SILC_SF_OUTBUF_PENDING 2 /* data in outbound buffer */
99 #define SILC_SF_DISCONNECTING 3 /* socket disconnecting */
100 #define SILC_SF_DISCONNECTED 4 /* socket disconnected */
101 #define SILC_SF_HOST_LOOKUP 5 /* performing host lookup for socket */
102 #define SILC_SF_DISABLED 6 /* socket connection is disabled,
103 no data is sent or received. */
105 /****s* silcutil/SilcSocketConnectionAPI/SilcSocketConnectionStruct
109 * struct SilcSocketConnectionStruct { ... };
113 * This object holds information about the connected sockets to the server.
114 * This is quite important object since this is referenced by the server all
115 * the time when figuring out what the connection is supposed to be doing
116 * and to whom we should send a message. This structure is the structure
117 * for the SilcSocketConnection forward declaration.
119 * Following short description of the fields:
123 * The actual connected socket. This is usually saved when accepting
124 * new connection to the server.
126 * SilcSocketType type
128 * Type of the socket. This identifies the type of the connection. This
129 * is mainly used to identify whether the connection is a client or a
134 * This is a pointer to a data that is is saved here at the same
135 * time a new connection object is allocated. Usually this is a
136 * back-pointer to some important data for fast referencing. For
137 * SILC server this is a pointer to the ID list and for SILC client
138 * to object holding active connections (windows).
140 * SilcProtocol protocol
142 * Protocol object for the socket. Currently only one protocol can be
143 * executing at a time for a particular socket.
147 * Socket flags that indicate the status of the socket. This can
148 * indicate several different status that can affect the use of the
153 * Reference counter. When allocated it is set to one (1) and it won't
154 * be freed until it hits zero (0).
160 * Resolved hostname, IP address and port of the connection who owns
166 * Incoming and outgoing buffers for the particular socket connection.
167 * Incoming data from the socket is put after decryption in to the
168 * inbuf buffer and outgoing data after encryption is put to the outbuf
171 * SilcSocketConnectionHB hb
173 * The heartbeat context. If NULL, heartbeat is not performed.
176 struct SilcSocketConnectionStruct {
180 SilcProtocol protocol;
182 SilcUInt8 sock_error;
192 SilcSocketConnectionHB hb;
197 /* Amount of bytes to be read from the socket connection at once. */
198 #define SILC_SOCKET_READ_SIZE 16384
200 /* Default socket buffer size. */
201 #define SILC_SOCKET_BUF_SIZE 1024
203 /* Generic manipulation of flags */
204 #define SF_SET(x, f) (x)->flags |= (1L << (f))
205 #define SF_UNSET(x, f) (x)->flags &= ~(1L << (f))
206 #define SF_IS(x, f) ((x)->flags & (1L << (f)))
208 /* Setting/Unsetting flags */
209 #define SILC_SET_OUTBUF_PENDING(x) SF_SET((x), SILC_SF_OUTBUF_PENDING)
210 #define SILC_SET_INBUF_PENDING(x) SF_SET((x), SILC_SF_INBUF_PENDING)
211 #define SILC_SET_DISCONNECTING(x) SF_SET((x), SILC_SF_DISCONNECTING)
212 #define SILC_SET_DISCONNECTED(x) SF_SET((x), SILC_SF_DISCONNECTED)
213 #define SILC_SET_HOST_LOOKUP(x) SF_SET((x), SILC_SF_HOST_LOOKUP)
214 #define SILC_SET_DISABLED(x) SF_SET((x), SILC_SF_HOST_LOOKUP)
215 #define SILC_UNSET_OUTBUF_PENDING(x) SF_UNSET((x), SILC_SF_OUTBUF_PENDING)
216 #define SILC_UNSET_INBUF_PENDING(x) SF_UNSET((x), SILC_SF_INBUF_PENDING)
217 #define SILC_UNSET_DISCONNECTING(x) SF_UNSET((x), SILC_SF_DISCONNECTING)
218 #define SILC_UNSET_DISCONNECTED(x) SF_UNSET((x), SILC_SF_DISCONNECTED)
219 #define SILC_UNSET_HOST_LOOKUP(x) SF_UNSET((x), SILC_SF_HOST_LOOKUP)
220 #define SILC_UNSET_DISABLED(x) SF_UNSET((x), SILC_SF_DISABLED)
222 /* Checking for flags */
223 #define SILC_IS_OUTBUF_PENDING(x) SF_IS((x), SILC_SF_OUTBUF_PENDING)
224 #define SILC_IS_INBUF_PENDING(x) SF_IS((x), SILC_SF_INBUF_PENDING)
225 #define SILC_IS_DISCONNECTING(x) SF_IS((x), SILC_SF_DISCONNECTING)
226 #define SILC_IS_DISCONNECTED(x) SF_IS((x), SILC_SF_DISCONNECTED)
227 #define SILC_IS_HOST_LOOKUP(x) SF_IS((x), SILC_SF_HOST_LOOKUP)
228 #define SILC_IS_DISABLED(x) SF_IS((x), SILC_SF_DISABLED)
232 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_alloc
236 * void silc_socket_alloc(int sock, SilcSocketType type, void *user_data,
237 * SilcSocketConnection *new_socket);
241 * Allocates a new socket connection object. The allocated object is
242 * returned to the new_socket argument. The `sock' is the socket
243 * for the connection, the `type' the initial type of the connection and
244 * the `user_data' a application specific pointer.
247 void silc_socket_alloc(int sock, SilcSocketType type, void *user_data,
248 SilcSocketConnection *new_socket);
250 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_free
254 * void silc_socket_free(SilcSocketConnection sock);
258 * Frees the socket connection context. This frees it only if the
259 * reference counter of the socket is zero, otherwise it decreases the
263 void silc_socket_free(SilcSocketConnection sock);
265 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_dup
269 * SilcSocketConnection silc_socket_dup(SilcSocketConnection sock);
273 * Duplicates the socket context. This actually does not duplicate
274 * any data, instead this increases the reference counter of the
275 * context. The reference counter is decreased by calling the
276 * silc_socket_free function and it frees the data when the counter
280 SilcSocketConnection silc_socket_dup(SilcSocketConnection sock);
282 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_read
286 * int silc_socket_read(SilcSocketConnection sock);
290 * Reads data from the socket connection into the incoming data buffer.
291 * It reads as much as possible from the socket connection. This returns
292 * amount of bytes read or -1 on error or -2 on case where all of the
293 * data could not be read at once. Implementation of this function
294 * may be platform specific.
297 int silc_socket_read(SilcSocketConnection sock);
299 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_write
303 * int silc_socket_write(SilcSocketConnection sock);
307 * Writes data from the outgoing buffer to the socket connection. If the
308 * data cannot be written at once, it must be written at later time.
309 * The data is written from the data section of the buffer, not from head
310 * or tail section. This automatically pulls the data section towards end
311 * after writing the data. Implementation of this function may be
315 int silc_socket_write(SilcSocketConnection sock);
317 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_get_error
321 * bool silc_socket_get_error(SilcSocketConnection sock, char *error,
322 * SilcUInt32 error_len);
326 * Returns human readable error message into the `error' buffer if
327 * the socket is in error status. Returns TRUE if error message was
328 * written into the buffer and FALSE if there is not socket error.
331 bool silc_socket_get_error(SilcSocketConnection sock, char *error,
332 SilcUInt32 error_len);
334 /****f* silcutil/SilcSocketConnectionAPI/SilcSocketConnectionHBCb
338 * typedef void (*SilcSocketConnectionHBCb)(SilcSocketConnection sock,
343 * Heartbeat callback function. This is the function in the application
344 * that this library will call when it is time to send the keepalive
345 * packet SILC_PACKET_HEARTBEAT.
348 typedef void (*SilcSocketConnectionHBCb)(SilcSocketConnection sock,
351 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_set_heartbeat
355 * void silc_socket_set_heartbeat(SilcSocketConnection sock,
356 * SilcUInt32 heartbeat,
358 * SilcSocketConnectionHBCb hb_callback,
359 * SilcSchedule schedule);
363 * Sets the heartbeat timeout and prepares the socket for performing
364 * heartbeat in `heartbeat' intervals (seconds). The `hb_context' is
365 * allocated by the application and will be sent as argument to the
366 * `hb_callback' function that is called when the `heartbeat' timeout
367 * expires. The callback `hb_context' won't be touched by the library
368 * but will be freed automatically when calling silc_socket_free. The
369 * `schedule' is the application's scheduler.
372 void silc_socket_set_heartbeat(SilcSocketConnection sock,
373 SilcUInt32 heartbeat,
375 SilcSocketConnectionHBCb hb_callback,
376 SilcSchedule schedule);
378 /****f* silcutil/SilcSocketConnectionAPI/SilcSocketHostLookupCb
382 * typedef void (*SilcSocketHostLookupCb)(SilcSocketConnection sock,
387 * Asynchronous host lookup callback function that will be called
388 * when the lookup is performed.
391 typedef void (*SilcSocketHostLookupCb)(SilcSocketConnection sock,
394 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_host_lookup
398 * void silc_socket_host_lookup(SilcSocketConnection sock,
400 * SilcSocketHostLookupCb callback,
402 * SilcSchedule schedule);
406 * Performs asynchronous host name and IP address lookups for the
407 * specified socket connection. This may be called when the socket
408 * connection is created and the full IP address and fully qualified
409 * domain name information is desired. The `callback' with `context'
410 * will be called after the lookup is performed. The `schedule'
411 * is the application's scheduler which the lookup routine needs.
412 * If the socket connection is freed during the lookup the library
413 * will automatically cancel the lookup and the `callback' will not be
416 * If `port_lookup' is TRUE then the remote port of the socket
417 * connection is resolved. After the information is resolved they
418 * are accessible using sock->ip and sock->hostname pointers. Note
419 * that if the both IP and FQDN could not be resolved the sock->hostname
420 * includes the IP address of the remote host. The resolved port is
421 * available in sock->port.
424 void silc_socket_host_lookup(SilcSocketConnection sock,
426 SilcSocketHostLookupCb callback,
428 SilcSchedule schedule);