1 /****h* silcutil/silcsockconn.h
9 * Author: Pekka Riikonen <priikone@silnet.org>
11 * Copyright (C) 1997 - 2001 Pekka Riikonen
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
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
98 #define SILC_SF_OUTBUF_PENDING 2
99 #define SILC_SF_DISCONNECTING 3
100 #define SILC_SF_DISCONNECTED 4
101 #define SILC_SF_HOST_LOOKUP 5
103 /****s* silcutil/SilcSocketConnectionAPI/SilcSocketConnectionStruct
107 * struct SilcSocketConnectionStruct { ... };
111 * This object holds information about the connected sockets to the server.
112 * This is quite important object since this is referenced by the server all
113 * the time when figuring out what the connection is supposed to be doing
114 * and to whom we should send a message. This structure is the structure
115 * for the SilcSocketConnection forward declaration.
117 * Following short description of the fields:
121 * The actual connected socket. This is usually saved when accepting
122 * new connection to the server.
124 * SilcSocketType type
126 * Type of the socket. This identifies the type of the connection. This
127 * is mainly used to identify whether the connection is a client or a
132 * This is a pointer to a data that is is saved here at the same
133 * time a new connection object is allocated. Usually this is a
134 * back-pointer to some important data for fast referencing. For
135 * SILC server this is a pointer to the ID list and for SILC client
136 * to object holding active connections (windows).
138 * SilcProtocol protocol
140 * Protocol object for the socket. Currently only one protocol can be
141 * executing at a time for a particular socket.
145 * Socket flags that indicate the status of the socket. This can
146 * indicate several different status that can affect the use of the
151 * Reference counter. When allocated it is set to one (1) and it won't
152 * be freed until it hits zero (0).
158 * Resolved hostname, IP address and port of the connection who owns
164 * Incoming and outgoing buffers for the particular socket connection.
165 * Incoming data from the socket is put after decryption in to the
166 * inbuf buffer and outgoing data after encryption is put to the outbuf
169 * SilcSocketConnectionHB hb
171 * The heartbeat context. If NULL, heartbeat is not performed.
174 struct SilcSocketConnectionStruct {
178 SilcProtocol protocol;
189 SilcSocketConnectionHB hb;
194 /* Amount of bytes to be read from the socket connection at once. */
195 #define SILC_SOCKET_READ_SIZE 16384
197 /* Default socket buffer size. */
198 #define SILC_SOCKET_BUF_SIZE 1024
200 /* Generic manipulation of flags */
201 #define SF_SET(x, f) (x)->flags |= (1L << (f))
202 #define SF_UNSET(x, f) (x)->flags &= ~(1L << (f))
203 #define SF_IS(x, f) ((x)->flags & (1L << (f)))
205 /* Setting/Unsetting flags */
206 #define SILC_SET_OUTBUF_PENDING(x) SF_SET((x), SILC_SF_OUTBUF_PENDING)
207 #define SILC_SET_INBUF_PENDING(x) SF_SET((x), SILC_SF_INBUF_PENDING)
208 #define SILC_SET_DISCONNECTING(x) SF_SET((x), SILC_SF_DISCONNECTING)
209 #define SILC_SET_DISCONNECTED(x) SF_SET((x), SILC_SF_DISCONNECTED)
210 #define SILC_SET_HOST_LOOKUP(x) SF_SET((x), SILC_SF_HOST_LOOKUP)
211 #define SILC_UNSET_OUTBUF_PENDING(x) SF_UNSET((x), SILC_SF_OUTBUF_PENDING)
212 #define SILC_UNSET_INBUF_PENDING(x) SF_UNSET((x), SILC_SF_INBUF_PENDING)
213 #define SILC_UNSET_DISCONNECTING(x) SF_UNSET((x), SILC_SF_DISCONNECTING)
214 #define SILC_UNSET_DISCONNECTED(x) SF_UNSET((x), SILC_SF_DISCONNECTED)
215 #define SILC_UNSET_HOST_LOOKUP(x) SF_UNSET((x), SILC_SF_HOST_LOOKUP)
217 /* Checking for flags */
218 #define SILC_IS_OUTBUF_PENDING(x) SF_IS((x), SILC_SF_OUTBUF_PENDING)
219 #define SILC_IS_INBUF_PENDING(x) SF_IS((x), SILC_SF_INBUF_PENDING)
220 #define SILC_IS_DISCONNECTING(x) SF_IS((x), SILC_SF_DISCONNECTING)
221 #define SILC_IS_DISCONNECTED(x) SF_IS((x), SILC_SF_DISCONNECTED)
222 #define SILC_IS_HOST_LOOKUP(x) SF_IS((x), SILC_SF_HOST_LOOKUP)
226 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_alloc
230 * void silc_socket_alloc(int sock, SilcSocketType type, void *user_data,
231 * SilcSocketConnection *new_socket);
235 * Allocates a new socket connection object. The allocated object is
236 * returned to the new_socket argument. The `sock' is the socket
237 * for the connection, the `type' the initial type of the connection and
238 * the `user_data' a application specific pointer.
241 void silc_socket_alloc(int sock, SilcSocketType type, void *user_data,
242 SilcSocketConnection *new_socket);
244 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_free
248 * void silc_socket_free(SilcSocketConnection sock);
252 * Frees the socket connection context. This frees it only if the
253 * reference counter of the socket is zero, otherwise it decreases the
257 void silc_socket_free(SilcSocketConnection sock);
259 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_dup
263 * SilcSocketConnection silc_socket_dup(SilcSocketConnection sock);
267 * Duplicates the socket context. This actually does not duplicate
268 * any data, instead this increases the reference counter of the
269 * context. The reference counter is decreased by calling the
270 * silc_socket_free function and it frees the data when the counter
274 SilcSocketConnection silc_socket_dup(SilcSocketConnection sock);
276 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_read
280 * int silc_socket_read(SilcSocketConnection sock);
284 * Reads data from the socket connection into the incoming data buffer.
285 * It reads as much as possible from the socket connection. This returns
286 * amount of bytes read or -1 on error or -2 on case where all of the
287 * data could not be read at once. Implementation of this function
288 * may be platform specific.
291 int silc_socket_read(SilcSocketConnection sock);
293 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_write
297 * int silc_socket_read(SilcSocketConnection sock);
301 * Writes data from the outgoing buffer to the socket connection. If the
302 * data cannot be written at once, it must be written at later time.
303 * The data is written from the data section of the buffer, not from head
304 * or tail section. This automatically pulls the data section towards end
305 * after writing the data. Implementation of this function may be
309 int silc_socket_write(SilcSocketConnection sock);
311 /****f* silcutil/SilcSocketConnectionAPI/SilcSocketConnectionHBCb
315 * typedef void (*SilcSocketConnectionHBCb)(SilcSocketConnection sock,
320 * Heartbeat callback function. This is the function in the application
321 * that this library will call when it is time to send the keepalive
322 * packet SILC_PACKET_HEARTBEAT.
325 typedef void (*SilcSocketConnectionHBCb)(SilcSocketConnection sock,
328 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_set_heartbeat
332 * void silc_socket_set_heartbeat(SilcSocketConnection sock,
335 * SilcSocketConnectionHBCb hb_callback,
336 * void *timeout_queue);
340 * Sets the heartbeat timeout and prepares the socket for performing
341 * heartbeat in `heartbeat' intervals (seconds). The `hb_context' is
342 * allocated by the application and will be sent as argument to the
343 * `hb_callback' function that is called when the `heartbeat' timeout
344 * expires. The callback `hb_context' won't be touched by the library
345 * but will be freed automatically when calling silc_socket_free. The
346 * `timeout_queue' is the application's scheduler timeout queue.
349 void silc_socket_set_heartbeat(SilcSocketConnection sock,
352 SilcSocketConnectionHBCb hb_callback,
353 void *timeout_queue);
355 /****f* silcutil/SilcSocketConnectionAPI/SilcSocketHostLookupCb
359 * typedef void (*SilcSocketHostLookupCb)(SilcSocketConnection sock,
364 * Asynchronous host lookup callback function that will be called
365 * when the lookup is performed.
368 typedef void (*SilcSocketHostLookupCb)(SilcSocketConnection sock,
371 /****f* silcutil/SilcSocketConnectionAPI/silc_socket_host_lookup
375 * void silc_socket_host_lookup(SilcSocketConnection sock,
376 * SilcSocketHostLookupCb callback,
378 * void *timeout_queue);
382 * Performs asynchronous host name and IP address lookups for the
383 * specified socket connection. This may be called when the socket
384 * connection is created and the full IP address and fully qualified
385 * domain name information is desired. The `callback' with `context'
386 * will be called after the lookup is performed. The `timeout_queue'
387 * is the application's scheduler timeout queue which the lookup
388 * routine needs. If the socket connection is freed during the
389 * lookup the library will automatically cancel the lookup and
390 * the `callback' will not be called.
392 * If `port_lookup' is TRUE then the remote port of the socket
393 * connection is resolved. After the information is resolved they
394 * are accessible using sock->ip and sock->hostname pointers. Note
395 * that if the both IP and FQDN could not be resolved the sock->hostname
396 * includes the IP address of the remote host. The resolved port is
397 * available in sock->port.
400 void silc_socket_host_lookup(SilcSocketConnection sock,
402 SilcSocketHostLookupCb callback,
404 void *timeout_queue);