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. If the `port'
128 * is zero (0), operating system will define it automatically.
130 * The `callback' always delivers valid new stream. It is not called
131 * with an error status.
135 silc_net_tcp_create_listener(const char **local_ip_addr,
136 SilcUInt32 local_ip_count, int port,
137 SilcBool lookup, SilcBool require_fqdn,
138 SilcSchedule schedule,
139 SilcNetCallback callback, void *context);
141 /****f* silcutil/SilcNetAPI/silc_net_listener_get_port
145 * SilcUInt16 silc_net_listener_get_port(SilcNetListener listener);
149 * Returns the ports to where the `listener' is bound. This can be used
150 * to get the port if none was specified in silc_net_tcp_create_listener.
151 * Returns an array of ports of size of `port_count'. The caller must
152 * free the array with silc_free. There are as many ports in the array
153 * as there were IP addresses provided in silc_net_tcp_create_listener.
156 SilcUInt16 *silc_net_listener_get_port(SilcNetListener listener,
157 SilcUInt32 *port_count);
159 /****f* silcutil/SilcNetAPI/silc_net_close_listener
163 * void silc_net_close_listener(SilcNetListener listener);
167 * Closes the network listener indicated by `listener'.
170 void silc_net_close_listener(SilcNetListener listener);
172 /****f* silcutil/SilcNetAPI/silc_net_tcp_connect
176 * SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr,
177 * const char *remote_ip_addr,
179 * SilcSchedule schedule,
180 * SilcNetCallback callback,
185 * Creates TCP/IP connection to the remote host indicated by `remote_host'
186 * which may be hostname or IP address, on the port indicated by
187 * `remote_port'. If the `local_ip_addr' is provided the local host is
188 * bound to that address before creating the connection. This is
189 * asynchronous call, and this function returns before the connection is
190 * actually established. The `callback' will be called after the
191 * connection is created to deliver the SilcStream for the created
192 * connection. This function supports IPv6 if the platform supports it.
194 * The returned SilcAsyncOperation context can be used to control the
195 * asynchronous connecting, such as to abort it. If it is aborted
196 * using silc_async_abort the `callback' will not be called. If NULL
197 * is returned the operation cannot be aborted.
200 SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr,
201 const char *remote_ip_addr,
203 SilcSchedule schedule,
204 SilcNetCallback callback,
207 /****f* silcutil/SilcNetAPI/silc_net_udp_connect
212 * silc_net_udp_connect(const char *local_ip_addr, int local_port,
213 * const char *remote_ip_addr, int remote_port,
214 * SilcSchedule schedule);
218 * This function creates UDP stream. The UDP stream is bound to the
219 * `local_ip_addr' if it is specified. If `local_port' is non-zero the
220 * stream is bound to that port. If the `remote_ip_addr' and `remote_port'
221 * is also provided, packets may be sent to that address using
222 * silc_stream_write function and packets may be received using
223 * silc_stream_read function.
225 * If the remote address is not provided the stream is in connectionless
226 * state. This means that packets can be received only by using
227 * silc_net_udp_receive and sent only by using the function
230 * To receive packets the silc_stream_set_notifier must be called for the
231 * returned SilcStream. The packets are always received in the notifier
232 * callback when the SILC_STREAM_CAN_READ is returned to the callback
233 * To read the packet use silc_stream_read if the remote address was
234 * provided, and silc_net_udp_receive if it was not.
236 * Supports IPv6 if the platform supports it.
240 * SilcStream udpstream;
242 * // Create UDP stream and prepare to receive packets
243 * udpstream = silc_net_udp_connect("10.2.1.7", 5000,
244 * "10.2.1.100, 5000, schedule);
245 * silc_stream_set_notifier(udpstream, schedule, receive_callback, context);
247 * // Send packet to remote host
248 * silc_stream_write(udpstream, data, data_len);
250 * Create UDP listener:
252 * udpstream = silc_net_udp_connect("0.0.0.0", 500, NULL, 0, schedule);
253 * silc_stream_set_notifier(udpstream, schedule, receive_callback, context);
256 SilcStream silc_net_udp_connect(const char *local_ip_addr, int local_port,
257 const char *remote_ip_addr, int remote_port,
258 SilcSchedule schedule);
260 /****f* silcutil/SilcNetAPI/silc_net_udp_receive
265 * silc_net_udp_receive(SilcStream stream, char *remote_ip_addr,
266 * SilcUInt32 remote_ip_addr_size, int *remote_port,
267 * unsigned char *ret_data, SilcUInt32 data_size)
271 * Receive a UDP packet from the `stream'. The IP address and port of
272 * the sender is returned into `remote_ip_addr' buffer and `remote_port'
273 * pointer. The packet data is returned into the `ret_data' buffer.
275 * Returns the length of the packet, or -1 on error or 0 in case of EOF.
278 int silc_net_udp_receive(SilcStream stream, char *remote_ip_addr,
279 SilcUInt32 remote_ip_addr_size, int *remote_port,
280 unsigned char *ret_data, SilcUInt32 data_size);
282 /****f* silcutil/SilcNetAPI/silc_net_udp_send
286 * int silc_net_udp_send(SilcStream stream,
287 * const char *remote_ip_addr, int remote_port,
288 * const unsigned char *data, SilcUInt32 data_len);
292 * Sends an UDP packet to remote host `remote_ip_addr' on `remote_port'.
293 * This may be used with UDP streams that are not connected to any
294 * specific remote host. With those stream silc_stream_write cannot be
295 * used. In those cases, this function must be used. This may also be
296 * used even if the stream is connected.
298 * Returns the amount of data written, -1 if data could not be written
299 * at this moment, or -2 if error occurred. If -1 is returned the
300 * notifier callback will later be called with SILC_STREAM_CAN_WRITE
301 * status when stream is again ready for writing.
304 int silc_net_udp_send(SilcStream stream,
305 const char *remote_ip_addr, int remote_port,
306 const unsigned char *data, SilcUInt32 data_len);
308 /****f* silcutil/SilcNetAPI/silc_net_close_connection
312 * void silc_net_close_connection(int sock);
316 * Closes the connection by closing the socket connection.
319 void silc_net_close_connection(int sock);
321 /****f* silcutil/SilcNetAPI/silc_net_accept_connection
325 * int silc_net_accept_connection(int sock);
329 * Accepts a connection from a particular socket.
332 int silc_net_accept_connection(int sock);
334 /****f* silcutil/SilcNetAPI/silc_net_set_socket_nonblock
338 * int silc_net_set_socket_nonblock(int sock);
342 * Sets the socket to non-blocking mode.
345 int silc_net_set_socket_nonblock(int sock);
347 /****f* silcutil/SilcNetAPI/silc_net_set_socket_opt
351 * int silc_net_set_socket_opt(int sock, int level, int option, int on);
355 * Sets a option for a socket. This function can be used to set
356 * various options for the socket. Some of the options might be
360 int silc_net_set_socket_opt(int sock, int level, int option, int on);
362 /****f* silcutil/SilcNetAPI/silc_net_get_socket_opt
366 * int silc_net_get_socket_opt(int sock, int level, int option,
367 * void *optval, int *opt_len);
371 * Return socket options to the `optval' and `opt_len'.
374 int silc_net_get_socket_opt(int sock, int level, int option,
375 void *optval, int *opt_len);
377 /****f* silcutil/SilcNetAPI/silc_net_is_ip4
381 * SilcBool silc_net_is_ip4(const char *addr);
385 * Checks whether IP address sent as argument is valid IPv4 address.
388 SilcBool silc_net_is_ip4(const char *addr);
390 /****f* silcutil/SilcNetAPI/silc_net_is_ip6
394 * SilcBool silc_net_is_ip6(const char *addr);
398 * Checks whether IP address sent as argument is valid IPv6 address.
401 SilcBool silc_net_is_ip6(const char *addr);
403 /****f* silcutil/SilcNetAPI/silc_net_is_ip
407 * SilcBool silc_net_is_ip(const char *addr);
411 * Checks whether IP address sent as argument is valid IP address.
412 * This supports both IPv4 and IPv6 addresses.
415 SilcBool silc_net_is_ip(const char *addr);
417 /****f* silcutil/SilcNetAPI/silc_net_addr2bin
421 * SilcBool silc_net_addr2bin(const char *addr, void *bin,
422 * SilcUInt32 bin_len);
426 * Converts the IP number string from numbers-and-dots notation to
427 * binary form in network byte order. The address can be either
428 * IPv4 or IPv6 address.
431 SilcBool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len);
433 /****f* silcutil/SilcNetAPI/SilcNetResolveCallback
437 * typedef void (*SilcNetResolveCallback)(const char *result,
442 * A callback function of this type is called after the asynchronous
443 * resolving operation has been completed. This callback is used
444 * when asynchronously resolving IP addresses and hostnames.
447 typedef void (*SilcNetResolveCallback)(const char *result, void *context);
449 /****f* silcutil/SilcNetAPI/silc_net_gethostbyname
453 * SilcBool silc_net_gethostbyname(const char *name, SilcBool prefer_ipv6,
454 * char *address, SilcUInt32 address_len);
458 * Resolves the IP address of the hostname indicated by the `name'.
459 * This returns TRUE and the IP address of the host to the `address'
460 * buffer, or FALSE if the address could not be resolved. This is
461 * synchronous function and will block the calling process. If the
462 * `prefer_ipv6' is TRUE then this will return IPv6 address if it
463 * finds. If FALSE if returns IPv4 address even if it found IPv6
467 SilcBool silc_net_gethostbyname(const char *name, SilcBool prefer_ipv6,
468 char *address, SilcUInt32 address_len);
470 /****f* silcutil/SilcNetAPI/silc_net_gethostbyname_async
474 * void silc_net_gethostbyname_async(const char *name,
475 * SilcBool prefer_ipv6,
476 * SilcSchedule schedule,
477 * SilcNetResolveCallback completion,
482 * Asynchronously resolves the IP address of the hostname indicated
483 * by the `name'. This function returns immediately, and the
484 * `completion' callback will be called after the resolving is
487 * If the `prefer_ipv6' is TRUE then this will return IPv6 address if it
488 * finds. If FALSE if returns IPv4 address even if it found IPv6
492 void silc_net_gethostbyname_async(const char *name,
493 SilcBool prefer_ipv6,
494 SilcSchedule schedule,
495 SilcNetResolveCallback completion,
498 /****f* silcutil/SilcNetAPI/silc_net_gethostbyaddr
502 * SilcBool silc_net_gethostbyaddr(const char *addr, char *name,
503 * SilcUInt32 name_len);
507 * Resolves the hostname for the IP address indicated by the `addr'
508 * This returns TRUE and the resolved hostname to the `name' buffer,
509 * or FALSE on error. The `addr' may be either IPv4 or IPv6 address.
510 * This is synchronous function and will block the calling process.
513 SilcBool silc_net_gethostbyaddr(const char *addr, char *name,
514 SilcUInt32 name_len);
516 /****f* silcutil/SilcNetAPI/silc_net_gethostbyaddr_async
520 * void silc_net_gethostbyaddr_async(const char *addr,
521 * SilcSchedule schedule,
522 * SilcNetResolveCallback completion,
527 * Asynchronously resolves the hostname for the IP address indicated
528 * by the `addr'. This function returns immediately, and the
529 * `completion' callback will be called after the resolving is
533 void silc_net_gethostbyaddr_async(const char *addr,
534 SilcSchedule schedule,
535 SilcNetResolveCallback completion,
538 /****f* silcutil/SilcNetAPI/silc_net_check_host_by_sock
542 * SilcBool silc_net_check_host_by_sock(int sock, char **hostname,
547 * Performs lookups for remote name and IP address. This peforms reverse
548 * lookup as well to verify that the IP has FQDN.
551 SilcBool silc_net_check_host_by_sock(int sock, char **hostname, char **ip);
553 /****f* silcutil/SilcNetAPI/silc_net_check_local_by_sock
557 * SilcBool silc_net_check_local_by_sock(int sock, char **hostname,
562 * Performs lookups for local name and IP address. This peforms reverse
563 * lookup as well to verify that the IP has FQDN.
566 SilcBool silc_net_check_local_by_sock(int sock, char **hostname, char **ip);
568 /****f* silcutil/SilcNetAPI/silc_net_get_remote_port
572 * SilcUInt16 silc_net_get_remote_port(int sock);
576 * Return remote port by socket.
579 SilcUInt16 silc_net_get_remote_port(int sock);
581 /****f* silcutil/SilcNetAPI/silc_net_get_local_port
585 * SilcUInt16 silc_net_get_local_port(int sock);
589 * Return local port by socket.
592 SilcUInt16 silc_net_get_local_port(int sock);
594 /****f* silcutil/SilcNetAPI/silc_net_localhost
598 * char *silc_net_localhost(void);
602 * Return name of localhost. This will also attempt to resolve
603 * the real hostname by the local host's IP address. If unsuccessful
604 * the first found hostname is returned. The caller must free
608 char *silc_net_localhost(void);
610 /****f* silcutil/SilcNetAPI/silc_net_localip
614 * char *silc_net_localip(void)
618 * Return IP of localhost. The caller must free the returned IP.
621 char *silc_net_localip(void);
623 /****f* silcutil/SilcNetAPI/silc_net_win32_init
627 * SilcBool silc_net_win32_init(void);
631 * This is WIN32 system specific function and is used to initialize
632 * the network. This must be called by all WIN32 applications. It
633 * is usually called at the application's main() or WinMain() before
634 * calling any other SILC routine. The application must also call
635 * the silc_net_win32_uninit when exiting the application. Returns
636 * FALSE on error. The network will not work if this function returns
641 * This routines is available only on Win32 platform.
644 SilcBool silc_net_win32_init(void);
646 /****f* silcutil/SilcNetAPI/silc_net_win32_uninit
650 * void silc_net_win32_init(void);
654 * This is WIN32 system specific function and is used to uninitialize
655 * the network. This must be called by all WIN32 applications. It
656 * is usually called when the application is exiting. After calling
657 * this function the SILC Net API routines will not work anymore.
661 * This routines is available only on Win32 platform.
664 void silc_net_win32_uninit(void);
666 #include "silcnet_i.h"
668 #endif /* SILCNET_H */