5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2006 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 Net Interface
24 * SILC Net API provides various network routines for applications. It
25 * can be used to create TCP/IP and UDP/IP connections and listeners.
26 * Various utility functions for resolving various information is also
29 * On WIN32 systems the SILC Net API must initialized by calling the
30 * silc_net_win32_init and uninitialized when the application ends by
31 * calling the silc_net_win32_uninit function. The initializing must be
32 * done in order to assure that the SILC Net API works correctly.
41 /****s* silcutil/SilcNetAPI/SilcNetListener
45 * typedef struct SilcNetListenerStruct *SilcNetListener;
49 * The network listenr context. This context is created with the
50 * silc_net_create_listener function and destroyed with
51 * silc_net_close_listener function.
54 typedef struct SilcNetListenerStruct *SilcNetListener;
56 /****d* silcutil/SilcNetAPI/SilcNetStatus
60 * typedef enum { ... } SilcNetStatus;
64 * Status to indicate the result of the network operation creation. This
65 * type is returned in the SilcNetCallback callback function.
70 SILC_NET_OK, /* Everything Ok */
71 SILC_NET_UNKNOWN_IP, /* Unknown IP address */
72 SILC_NET_UNKNOWN_HOST, /* Unknown hostname */
73 SILC_NET_HOST_UNREACHABLE, /* Destination unreachable */
74 SILC_NET_CONNECTION_REFUSED, /* Connection refused */
75 SILC_NET_CONNECTION_TIMEOUT, /* Connection timedout */
76 SILC_NET_NO_MEMORY, /* System out of memory */
77 SILC_NET_ERROR, /* Unknown error */
81 /****f* silcutil/SilcNetAPI/SilcNetCallback
85 * typedef void (*SilcNetCallback)(SilcNetStatus status,
86 * SilcStream stream, void *context);
90 * A callback of this type is returned by silc_net_tcp_create_listener
91 * and silc_net_tcp_connect functions. For silc_net_tcp_create_listener
92 * this callback means that new incoming connection was accepted, and the
93 * `stream' is the socket stream representing the socket connection.
95 * For silc_net_tcp_connect this means that we have connected to the
96 * remote host and the `stream' is the socket stream for the socket
97 * connection. The SILC Stream API (such as silc_stream_read, etc.) can
98 * be used to read and write to the stream. The created stream is socket
99 * stream so various SilcSocketStream API functions can be used with
103 typedef void (*SilcNetCallback)(SilcNetStatus status,
104 SilcStream stream, void *context);
106 /****f* silcutil/SilcNetAPI/silc_net_tcp_create_listener
111 * silc_net_tcp_create_listener(const char **local_ip_addr,
112 * SilcUInt32 local_ip_count, int port,
113 * SilcBool lookup, SilcBool require_fqdn,
114 * SilcSchedule schedule,
115 * SilcNetCallback callback, void *context);
119 * This function creates TCP listener. This is used to create network
120 * listener for incoming connections, and `callback' will be called
121 * everytime new connection is received. If `local_ip_addr' is NULL any
122 * address is used. If provided it can be used bind the listener to
123 * `local_ip_count' many IP addresses provided in `local_ip_addr' table.
124 * On success returns the SilcNetListener context, or NULL on error.
125 * If `require_fqdn' is TRUE the listener will require that the incoming
126 * connection has FQDN to be able to connect. If the `lookup' is TRUE
127 * then the incoming connection hostname will be resolved.
131 silc_net_tcp_create_listener(const char **local_ip_addr,
132 SilcUInt32 local_ip_count, int port,
133 SilcBool lookup, SilcBool require_fqdn,
134 SilcSchedule schedule,
135 SilcNetCallback callback, void *context);
137 /****f* silcutil/SilcNetAPI/silc_net_close_listener
141 * void silc_net_close_listener(SilcNetListener listener);
145 * Closes the network listener indicated by `listener'.
148 void silc_net_close_listener(SilcNetListener listener);
150 /****f* silcutil/SilcNetAPI/silc_net_tcp_connect
154 * SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr,
155 * const char *remote_ip_addr,
157 * SilcSchedule schedule,
158 * SilcNetCallback callback,
163 * Creates TCP/IP connection to the remote host indicated by `remote_host'
164 * which may be hostname or IP address, on the port indicated by
165 * `remote_port'. If the `local_ip_addr' is provided the local host is
166 * bound to that address before creating the connection. This is
167 * asynchronous call, and this function returns before the connection is
168 * actually established. The `callback' will be called after the
169 * connection is created to deliver the SilcStream for the created
170 * connection. This function supports IPv6 if the platform supports it.
172 * The returned SilcAsyncOperation context can be used to control the
173 * asynchronous connecting, such as to abort it. If it is aborted
174 * using silc_async_abort the `callback' will not be called. If NULL
175 * is returned the operation cannot be aborted.
178 SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr,
179 const char *remote_ip_addr,
181 SilcSchedule schedule,
182 SilcNetCallback callback,
185 /****f* silcutil/SilcNetAPI/silc_net_udp_connect
190 * silc_net_udp_connect(const char *local_ip_addr, int local_port,
191 * const char *remote_ip_addr, int remote_port,
192 * SilcSchedule schedule);
196 * This function creates UDP stream. The UDP stream is bound to the
197 * `local_ip_addr' if it is specified. If `local_port' is non-zero the
198 * stream is bound to that port. If the `remote_ip_addr' and `remote_port'
199 * is also provided, packets may be sent to that address using
200 * silc_stream_write function and packets may be received using
201 * silc_stream_read function.
203 * If the remote address is not provided then packets may only be received
204 * by using silc_net_udp_receive and sent only by using the function
207 * To receive packets the silc_stream_set_notifier must be called for the
208 * returned SilcStream. The packets are always received in the notifier
209 * callback when the SILC_STREAM_CAN_READ is returned to the callback
210 * To read the packet use silc_stream_read if the remote address was
211 * provided, and silc_net_udp_receive if it was not.
213 * Supports IPv6 if the platform supports it.
217 * SilcStream udpstream;
219 * // Create UDP stream and prepare to receive packets
220 * udpstream = silc_net_udp_connect("10.2.1.7", 5000,
221 * "10.2.1.100, 5000, schedule);
222 * silc_stream_set_notifier(udpstream, schedule, receive_callback, context);
224 * // Send packet to remote host
225 * silc_stream_write(udpstream, data, data_len);
227 * Create UDP listener:
229 * udpstream = silc_net_udp_connect("0.0.0.0", 500, NULL, 0, schedule);
230 * silc_stream_set_notifier(udpstream, schedule, receive_callback, context);
233 SilcStream silc_net_udp_connect(const char *local_ip_addr, int local_port,
234 const char *remote_ip_addr, int remote_port,
235 SilcSchedule schedule);
237 /****f* silcutil/SilcNetAPI/silc_net_udp_receive
242 * silc_net_udp_receive(SilcStream stream, char *remote_ip_addr,
243 * SilcUInt32 remote_ip_addr_size, int *remote_port,
244 * unsigned char *ret_data, SilcUInt32 data_size)
248 * Receive a UDP packet from the `stream'. The IP address and port of
249 * the sender is returned into `remote_ip_addr' buffer and `remote_port'
250 * pointer. The packet data is returned into the `ret_data' buffer.
252 * Returns the length of the packet, or -1 on error or 0 in case of EOF.
255 int silc_net_udp_receive(SilcStream stream, char *remote_ip_addr,
256 SilcUInt32 remote_ip_addr_size, int *remote_port,
257 unsigned char *ret_data, SilcUInt32 data_size);
259 /****f* silcutil/SilcNetAPI/silc_net_udp_send
263 * void silc_net_udp_send(SilcStream stream,
264 * const char *remote_ip_addr, int remote_port,
265 * const unsigned char *data, SilcUInt32 data_len);
269 * Sends an UDP packet to remote host `remote_ip_addr' on `remote_port'.
270 * This may be used with UDP streams that are not connected to any
271 * specific remote host. With those stream silc_stream_write cannot be
272 * used. In those cases, this function must be used. This may also be
273 * used even if the stream is connected.
275 * This function always succeeds, however there is no guarantee that the
276 * packet is delivered, as UDP is unreliable transport protocol.
279 void silc_net_udp_send(SilcStream stream,
280 const char *remote_ip_addr, int remote_port,
281 const unsigned char *data, SilcUInt32 data_len);
283 /****f* silcutil/SilcNetAPI/silc_net_close_connection
287 * void silc_net_close_connection(int sock);
291 * Closes the connection by closing the socket connection.
294 void silc_net_close_connection(int sock);
296 /****f* silcutil/SilcNetAPI/silc_net_accept_connection
300 * int silc_net_accept_connection(int sock);
304 * Accepts a connection from a particular socket.
307 int silc_net_accept_connection(int sock);
309 /****f* silcutil/SilcNetAPI/silc_net_set_socket_nonblock
313 * int silc_net_set_socket_nonblock(int sock);
317 * Sets the socket to non-blocking mode.
320 int silc_net_set_socket_nonblock(int sock);
322 /****f* silcutil/SilcNetAPI/silc_net_set_socket_opt
326 * int silc_net_set_socket_opt(int sock, int level, int option, int on);
330 * Sets a option for a socket. This function can be used to set
331 * various options for the socket. Some of the options might be
335 int silc_net_set_socket_opt(int sock, int level, int option, int on);
337 /****f* silcutil/SilcNetAPI/silc_net_get_socket_opt
341 * int silc_net_get_socket_opt(int sock, int level, int option,
342 * void *optval, int *opt_len);
346 * Return socket options to the `optval' and `opt_len'.
349 int silc_net_get_socket_opt(int sock, int level, int option,
350 void *optval, int *opt_len);
352 /****f* silcutil/SilcNetAPI/silc_net_is_ip4
356 * SilcBool silc_net_is_ip4(const char *addr);
360 * Checks whether IP address sent as argument is valid IPv4 address.
363 SilcBool silc_net_is_ip4(const char *addr);
365 /****f* silcutil/SilcNetAPI/silc_net_is_ip6
369 * SilcBool silc_net_is_ip6(const char *addr);
373 * Checks whether IP address sent as argument is valid IPv6 address.
376 SilcBool silc_net_is_ip6(const char *addr);
378 /****f* silcutil/SilcNetAPI/silc_net_is_ip
382 * SilcBool silc_net_is_ip(const char *addr);
386 * Checks whether IP address sent as argument is valid IP address.
387 * This supports both IPv4 and IPv6 addresses.
390 SilcBool silc_net_is_ip(const char *addr);
392 /****f* silcutil/SilcNetAPI/silc_net_addr2bin
396 * SilcBool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len);
400 * Converts the IP number string from numbers-and-dots notation to
401 * binary form in network byte order. The address can be either
402 * IPv4 or IPv6 address.
405 SilcBool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len);
407 /****f* silcutil/SilcNetAPI/SilcNetResolveCallback
411 * typedef void (*SilcNetResolveCallback)(const char *result,
416 * A callback function of this type is called after the asynchronous
417 * resolving operation has been completed. This callback is used
418 * when asynchronously resolving IP addresses and hostnames.
421 typedef void (*SilcNetResolveCallback)(const char *result, void *context);
423 /****f* silcutil/SilcNetAPI/silc_net_gethostbyname
427 * SilcBool silc_net_gethostbyname(const char *name, SilcBool prefer_ipv6,
428 * char *address, SilcUInt32 address_len);
432 * Resolves the IP address of the hostname indicated by the `name'.
433 * This returns TRUE and the IP address of the host to the `address'
434 * buffer, or FALSE if the address could not be resolved. This is
435 * synchronous function and will block the calling process. If the
436 * `prefer_ipv6' is TRUE then this will return IPv6 address if it
437 * finds. If FALSE if returns IPv4 address even if it found IPv6
441 SilcBool silc_net_gethostbyname(const char *name, SilcBool prefer_ipv6,
442 char *address, SilcUInt32 address_len);
444 /****f* silcutil/SilcNetAPI/silc_net_gethostbyname_async
448 * void silc_net_gethostbyname_async(const char *name,
449 * SilcBool prefer_ipv6,
450 * SilcSchedule schedule,
451 * SilcNetResolveCallback completion,
456 * Asynchronously resolves the IP address of the hostname indicated
457 * by the `name'. This function returns immediately, and the
458 * `completion' callback will be called after the resolving is
461 * If the `prefer_ipv6' is TRUE then this will return IPv6 address if it
462 * finds. If FALSE if returns IPv4 address even if it found IPv6
466 void silc_net_gethostbyname_async(const char *name,
467 SilcBool prefer_ipv6,
468 SilcSchedule schedule,
469 SilcNetResolveCallback completion,
472 /****f* silcutil/SilcNetAPI/silc_net_gethostbyaddr
476 * SilcBool silc_net_gethostbyaddr(const char *addr, char *name,
477 * SilcUInt32 name_len);
481 * Resolves the hostname for the IP address indicated by the `addr'
482 * This returns TRUE and the resolved hostname to the `name' buffer,
483 * or FALSE on error. The `addr' may be either IPv4 or IPv6 address.
484 * This is synchronous function and will block the calling process.
487 SilcBool silc_net_gethostbyaddr(const char *addr, char *name,
488 SilcUInt32 name_len);
490 /****f* silcutil/SilcNetAPI/silc_net_gethostbyaddr_async
494 * void silc_net_gethostbyaddr_async(const char *addr,
495 * SilcSchedule schedule,
496 * SilcNetResolveCallback completion,
501 * Asynchronously resolves the hostname for the IP address indicated
502 * by the `addr'. This function returns immediately, and the
503 * `completion' callback will be called after the resolving is
507 void silc_net_gethostbyaddr_async(const char *addr,
508 SilcSchedule schedule,
509 SilcNetResolveCallback completion,
512 /****f* silcutil/SilcNetAPI/silc_net_check_host_by_sock
516 * SilcBool silc_net_check_host_by_sock(int sock, char **hostname,
521 * Performs lookups for remote name and IP address. This peforms reverse
522 * lookup as well to verify that the IP has FQDN.
525 SilcBool silc_net_check_host_by_sock(int sock, char **hostname, char **ip);
527 /****f* silcutil/SilcNetAPI/silc_net_check_local_by_sock
531 * SilcBool silc_net_check_local_by_sock(int sock, char **hostname,
536 * Performs lookups for local name and IP address. This peforms reverse
537 * lookup as well to verify that the IP has FQDN.
540 SilcBool silc_net_check_local_by_sock(int sock, char **hostname, char **ip);
542 /****f* silcutil/SilcNetAPI/silc_net_get_remote_port
546 * SilcUInt16 silc_net_get_remote_port(int sock);
550 * Return remote port by socket.
553 SilcUInt16 silc_net_get_remote_port(int sock);
555 /****f* silcutil/SilcNetAPI/silc_net_get_local_port
559 * SilcUInt16 silc_net_get_local_port(int sock);
563 * Return local port by socket.
566 SilcUInt16 silc_net_get_local_port(int sock);
568 /****f* silcutil/SilcNetAPI/silc_net_localhost
572 * char *silc_net_localhost(void);
576 * Return name of localhost. This will also attempt to resolve
577 * the real hostname by the local host's IP address. If unsuccessful
578 * the first found hostname is returned. The caller must free
582 char *silc_net_localhost(void);
584 /****f* silcutil/SilcNetAPI/silc_net_localip
588 * char *silc_net_localip(void)
592 * Return IP of localhost. The caller must free the returned IP.
595 char *silc_net_localip(void);
597 /****f* silcutil/SilcNetAPI/silc_net_win32_init
601 * SilcBool silc_net_win32_init(void);
605 * This is WIN32 system specific function and is used to initialize
606 * the network. This must be called by all WIN32 applications. It
607 * is usually called at the application's main() or WinMain() before
608 * calling any other SILC routine. The application must also call
609 * the silc_net_win32_uninit when exiting the application. Returns
610 * FALSE on error. The network will not work if this function returns
615 * This routines is available only on Win32 platform.
618 SilcBool silc_net_win32_init(void);
620 /****f* silcutil/SilcNetAPI/silc_net_win32_uninit
624 * void silc_net_win32_init(void);
628 * This is WIN32 system specific function and is used to uninitialize
629 * the network. This must be called by all WIN32 applications. It
630 * is usually called when the application is exiting. After calling
631 * this function the SILC Net API routines will not work anymore.
635 * This routines is available only on Win32 platform.
638 void silc_net_win32_uninit(void);
640 #include "silcnet_i.h"
642 #endif /* SILCNET_H */