X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilcnet.h;h=3bbc40ab665501b7b3c34625d347afcb8408b7a0;hb=52e57c880aba9c5e89f59d962eb9af75670b76e0;hp=08168fa31f794e90b6ffcec3e4dafcf09d175798;hpb=c27a4ecc3e616e8a5ee09b8ca888ed6ff3e501f7;p=silc.git diff --git a/lib/silcutil/silcnet.h b/lib/silcutil/silcnet.h index 08168fa3..3bbc40ab 100644 --- a/lib/silcutil/silcnet.h +++ b/lib/silcutil/silcnet.h @@ -4,7 +4,7 @@ Author: Pekka Riikonen - Copyright (C) 1997 - 2005 Pekka Riikonen + Copyright (C) 1997 - 2007 Pekka Riikonen This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -22,8 +22,9 @@ * DESCRIPTION * * SILC Net API provides various network routines for applications. It - * can be used to create TCP/IP connections and servers. Various utility - * functions for resolving various information is also provided. + * can be used to create TCP/IP and UDP/IP connections and listeners. + * Various utility functions for resolving various information is also + * provided. * * On WIN32 systems the SILC Net API must initialized by calling the * silc_net_win32_init and uninitialized when the application ends by @@ -37,20 +38,20 @@ /* Prototypes */ -/****s* silcutil/SilcNetAPI/SilcNetServer +/****s* silcutil/SilcNetAPI/SilcNetListener * * NAME * - * typedef struct SilcNetServerStruct *SilcNetServer; + * typedef struct SilcNetListenerStruct *SilcNetListener; * * DESCRIPTION * - * The network server (daemon, listener, etc.) context. This context - * is created with the silc_net_create_server function and destroyed - * with silc_net_close_server function. + * The network listenr context. This context is created with the + * silc_net_create_listener function and destroyed with + * silc_net_close_listener function. * ***/ -typedef struct SilcNetServerStruct *SilcNetServer; +typedef struct SilcNetListenerStruct *SilcNetListener; /****d* silcutil/SilcNetAPI/SilcNetStatus * @@ -86,64 +87,123 @@ typedef enum { * * DESCRIPTION * - * A callback function of this type is returned by silc_net_create_server - * and silc_net_connect_async functions. For silc_net_create_server this - * callback means that new incoming connection was accepted, and the + * A callback of this type is returned by silc_net_tcp_create_listener + * and silc_net_tcp_connect functions. For silc_net_tcp_create_listener + * this callback means that new incoming connection was accepted, and the * `stream' is the socket stream representing the socket connection. * - * For silc_net_connect_async this means that we have connected to the + * For silc_net_tcp_connect this means that we have connected to the * remote host and the `stream' is the socket stream for the socket - * connection. The SILC Stream API (such as silc_stream_read, etc.) - * can be used to read and write to the stream. The created stream - * is socket stream so various SilcSocketStream API functions can be - * used with the `stream'. + * connection. The SILC Stream API (such as silc_stream_read, etc.) can + * be used to read and write to the stream. The created stream is socket + * stream so various SilcSocketStream API functions can be used with + * the `stream'. * ***/ typedef void (*SilcNetCallback)(SilcNetStatus status, SilcStream stream, void *context); -/****f* silcutil/SilcNetAPI/silc_net_create_server +/****f* silcutil/SilcNetAPI/silc_net_tcp_create_listener * * SYNOPSIS * - * SilcNetServer - * silc_net_create_server(const char **local_ip_addr, - * SilcUInt32 local_ip_count, - * int port, SilcBool require_fqdn, - * SilcSchedule schedule, - * SilcNetCallback callback, void *context); + * SilcNetListener + * silc_net_tcp_create_listener(const char **local_ip_addr, + * SilcUInt32 local_ip_count, int port, + * SilcBool lookup, SilcBool require_fqdn, + * SilcSchedule schedule, + * SilcNetCallback callback, void *context); * * DESCRIPTION * - * This function creates server or daemon or listener etc. This is used - * to create network listener for incoming connections, and `callback' - * will be called everytime new connection is received. If `local_ip_addr' - * is NULL any address is used. If provided it can be used bind the - * server to `local_ip_count' many IP addresses provided in `local_ip_addr' - * table. On success returns the SilcNetServer context, or NULL on error. - * If `require_fqdn' is TRUE the server will require that the incoming - * connection has FQDN to be able to connect. + * This function creates TCP listener. This is used to create network + * listener for incoming connections, and `callback' will be called + * everytime new connection is received. If `local_ip_addr' is NULL 'any' + * address is used. If provided it can be used bind the listener to + * `local_ip_count' many IP addresses provided in `local_ip_addr' table. + * On success returns the SilcNetListener context, or NULL on error. + * If `require_fqdn' is TRUE the listener will require that the incoming + * connection has FQDN to be able to connect. If the `lookup' is TRUE + * then the incoming connection hostname will be resolved. If the `port' + * is zero (0), operating system will define it automatically. + * + * The `callback' always delivers valid new stream. It is not called + * with an error status. + * + ***/ +SilcNetListener +silc_net_tcp_create_listener(const char **local_ip_addr, + SilcUInt32 local_ip_count, int port, + SilcBool lookup, SilcBool require_fqdn, + SilcSchedule schedule, + SilcNetCallback callback, void *context); + +/****f* silcutil/SilcNetAPI/silc_net_listener_get_port + * + * SYNOPSIS + * + * SilcUInt16 silc_net_listener_get_port(SilcNetListener listener); + * + * DESCRIPTION + * + * Returns the ports to where the `listener' is bound. This can be used + * to get the port if none was specified in silc_net_tcp_create_listener. + * Returns an array of ports of size of `port_count'. The caller must + * free the array with silc_free. There are as many ports in the array + * as there were IP addresses provided in silc_net_tcp_create_listener. + * + ***/ +SilcUInt16 *silc_net_listener_get_port(SilcNetListener listener, + SilcUInt32 *port_count); + +/****f* silcutil/SilcNetAPI/silc_net_listener_get_ip + * + * SYNOPSIS + * + * char **silc_net_listener_get_ip(SilcNetListener listener, + * SilcUInt32 *ip_count); + * + * DESCRIPTION + * + * Returns the IP's to where the `listener' is bound. Returns an array + * of IP addresses of size of `port_count'. The caller must free the + * array and its strings with silc_free. * ***/ -SilcNetServer -silc_net_create_server(const char **local_ip_addr, SilcUInt32 local_ip_count, - int port, SilcBool require_fqdn, SilcSchedule schedule, - SilcNetCallback callback, void *context); +char **silc_net_listener_get_ip(SilcNetListener listener, + SilcUInt32 *ip_count); -/****f* silcutil/SilcNetAPI/silc_net_close_server +/****f* silcutil/SilcNetAPI/silc_net_listener_get_hostname * * SYNOPSIS * - * void silc_net_close_server(SilcNetServer server); + * char **silc_net_listener_get_hostname(SilcNetListener listener, + * SilcUInt32 *hostname_count); * * DESCRIPTION * - * Closes the network server listener indicated by `server'. + * Returns the hostnames to where the `listener' is bound. Returns an + * array of hostnames of size of `port_count'. The caller must free the + * array and its strings with silc_free. * ***/ -void silc_net_close_server(SilcNetServer server); +char **silc_net_listener_get_hostname(SilcNetListener listener, + SilcUInt32 *hostname_count); -/****f* silcutil/SilcNetAPI/silc_net_connect +/****f* silcutil/SilcNetAPI/silc_net_close_listener + * + * SYNOPSIS + * + * void silc_net_close_listener(SilcNetListener listener); + * + * DESCRIPTION + * + * Closes the network listener indicated by `listener'. + * + ***/ +void silc_net_close_listener(SilcNetListener listener); + +/****f* silcutil/SilcNetAPI/silc_net_tcp_connect * * SYNOPSIS * @@ -163,15 +223,14 @@ void silc_net_close_server(SilcNetServer server); * asynchronous call, and this function returns before the connection is * actually established. The `callback' will be called after the * connection is created to deliver the SilcStream for the created - * connection. + * connection. This function supports IPv6 if the platform supports it. * * The returned SilcAsyncOperation context can be used to control the * asynchronous connecting, such as to abort it. If it is aborted * using silc_async_abort the `callback' will not be called. If NULL - * is returned the operation cannot be aborted and the `callback' will - * be called eventually. + * is returned the operation cannot be aborted. * - */ + ***/ SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr, const char *remote_ip_addr, int remote_port, @@ -179,51 +238,148 @@ SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr, SilcNetCallback callback, void *context); -SilcAsyncOperation silc_net_udp_connect(const char *local_ip_addr, - const char *remote_ip_addr, - int remote_port, - SilcSchedule schedule, - SilcNetCallback callback, - void *context); +/****f* silcutil/SilcNetAPI/silc_net_udp_connect + * + * SYNOPSIS + * + * SilcStream + * silc_net_udp_connect(const char *local_ip_addr, int local_port, + * const char *remote_ip_addr, int remote_port, + * SilcSchedule schedule); + * + * DESCRIPTION + * + * This function creates UDP stream. The UDP stream is bound to the + * `local_ip_addr' if it is specified. If `local_port' is non-zero the + * stream is bound to that port. If the `remote_ip_addr' and `remote_port' + * is also provided, packets may be sent to that address using + * silc_stream_write function and packets may be received using + * silc_stream_read function. + * + * If the remote address is not provided the stream is in connectionless + * state. This means that packets can be received only by using + * silc_net_udp_receive and sent only by using the function + * silc_net_udp_send. + * + * To receive packets the silc_stream_set_notifier must be called for the + * returned SilcStream. The packets are always received in the notifier + * callback when the SILC_STREAM_CAN_READ is returned to the callback + * To read the packet use silc_stream_read if the remote address was + * provided, and silc_net_udp_receive if it was not. + * + * Supports IPv6 if the platform supports it. + * + * EXAMPLE + * + * SilcStream udpstream; + * + * // Create UDP stream and prepare to receive packets + * udpstream = silc_net_udp_connect("10.2.1.7", 5000, + * "10.2.1.100, 5000, schedule); + * silc_stream_set_notifier(udpstream, schedule, receive_callback, context); + * + * // Send packet to remote host + * silc_stream_write(udpstream, data, data_len); + * + * Create UDP listener: + * + * udpstream = silc_net_udp_connect("0.0.0.0", 500, NULL, 0, schedule); + * silc_stream_set_notifier(udpstream, schedule, receive_callback, context); + * + ***/ +SilcStream silc_net_udp_connect(const char *local_ip_addr, int local_port, + const char *remote_ip_addr, int remote_port, + SilcSchedule schedule); -/****f* silcutil/SilcNetAPI/silc_net_close_connection +/****f* silcutil/SilcNetAPI/silc_net_udp_receive * * SYNOPSIS * - * void silc_net_close_connection(int sock); + * int + * silc_net_udp_receive(SilcStream stream, char *remote_ip_addr, + * SilcUInt32 remote_ip_addr_size, int *remote_port, + * unsigned char *ret_data, SilcUInt32 data_size) * * DESCRIPTION * - * Closes the connection by closing the socket connection. + * Receive a UDP packet from the `stream'. The IP address and port of + * the sender is returned into `remote_ip_addr' buffer and `remote_port' + * pointer. The packet data is returned into the `ret_data' buffer. + * + * Returns the length of the packet, or -1 on error or 0 in case of EOF. * ***/ -void silc_net_close_connection(int sock); +int silc_net_udp_receive(SilcStream stream, char *remote_ip_addr, + SilcUInt32 remote_ip_addr_size, int *remote_port, + unsigned char *ret_data, SilcUInt32 data_size); -/****f* silcutil/SilcNetAPI/silc_net_accept_connection +/****f* silcutil/SilcNetAPI/silc_net_udp_send * * SYNOPSIS * - * int silc_net_accept_connection(int sock); + * int silc_net_udp_send(SilcStream stream, + * const char *remote_ip_addr, int remote_port, + * const unsigned char *data, SilcUInt32 data_len); + * + * DESCRIPTION + * + * Sends an UDP packet to remote host `remote_ip_addr' on `remote_port'. + * This may be used with UDP streams that are not connected to any + * specific remote host. With those stream silc_stream_write cannot be + * used. In those cases, this function must be used. This may also be + * used even if the stream is connected. + * + * Returns the amount of data written, -1 if data could not be written + * at this moment, or -2 if error occurred. If -1 is returned the + * notifier callback will later be called with SILC_STREAM_CAN_WRITE + * status when stream is again ready for writing. + * + ***/ +int silc_net_udp_send(SilcStream stream, + const char *remote_ip_addr, int remote_port, + const unsigned char *data, SilcUInt32 data_len); + +/****f* silcutil/SilcNetAPI/silc_net_get_error_string + * + * SYNOPSIS + * + * const char silc_net_get_error_string(SilcNetStatus error); * * DESCRIPTION * - * Accepts a connection from a particular socket. + * Return `error' as a string. * ***/ -int silc_net_accept_connection(int sock); +const char *silc_net_get_error_string(SilcNetStatus error); -/****f* silcutil/SilcNetAPI/silc_net_set_socket_nonblock +/****f* silcutil/SilcNetAPI/silc_net_close_connection + * + * SYNOPSIS + * + * void silc_net_close_connection(int sock); + * + * DESCRIPTION + * + * Closes the connection by closing the socket connection. This routine + * can only be used with POSIX compliant systems. + * + ***/ +void silc_net_close_connection(int sock); + +/****f* silcutil/SilcNetAPI/silc_net_accept_connection * * SYNOPSIS * - * int silc_net_set_socket_nonblock(int sock); + * int silc_net_accept_connection(int sock); * * DESCRIPTION * - * Sets the socket to non-blocking mode. + * Accepts a connection from a particular socket. This routine can only + * be used with POSIX compliant systems. This call is equivalent to + * accept(2). * ***/ -int silc_net_set_socket_nonblock(int sock); +int silc_net_accept_connection(int sock); /****f* silcutil/SilcNetAPI/silc_net_set_socket_opt * @@ -235,7 +391,8 @@ int silc_net_set_socket_nonblock(int sock); * * Sets a option for a socket. This function can be used to set * various options for the socket. Some of the options might be - * system specific. + * system specific. This routine can only be used with POSIX compliant + * systems. This call is equivalent to setsockopt(2); * ***/ int silc_net_set_socket_opt(int sock, int level, int option, int on); @@ -249,12 +406,27 @@ int silc_net_set_socket_opt(int sock, int level, int option, int on); * * DESCRIPTION * - * Return socket options to the `optval' and `opt_len'. + * Return socket options to the `optval' and `opt_len'. This routine + * can only be used with POSIX compliant systems. This call is + * equivalent to getsockopt(2). * ***/ int silc_net_get_socket_opt(int sock, int level, int option, void *optval, int *opt_len); +/****f* silcutil/SilcNetAPI/silc_net_set_socket_nonblock + * + * SYNOPSIS + * + * int silc_net_set_socket_nonblock(SilcSocket sock); + * + * DESCRIPTION + * + * Sets the socket `sock' to non-blocking mode. + * + ***/ +int silc_net_set_socket_nonblock(SilcSocket sock); + /****f* silcutil/SilcNetAPI/silc_net_is_ip4 * * SYNOPSIS @@ -299,7 +471,8 @@ SilcBool silc_net_is_ip(const char *addr); * * SYNOPSIS * - * SilcBool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len); + * SilcBool silc_net_addr2bin(const char *addr, void *bin, + * SilcUInt32 bin_len); * * DESCRIPTION * @@ -331,7 +504,7 @@ typedef void (*SilcNetResolveCallback)(const char *result, void *context); * SYNOPSIS * * SilcBool silc_net_gethostbyname(const char *name, SilcBool prefer_ipv6, - * char *address, SilcUInt32 address_len); + * char *address, SilcUInt32 address_len); * * DESCRIPTION * @@ -344,8 +517,8 @@ typedef void (*SilcNetResolveCallback)(const char *result, void *context); * address also. * ***/ -SilcBool silc_net_gethostbyname(const char *name, SilcBool prefer_ipv6, char *address, - SilcUInt32 address_len); +SilcBool silc_net_gethostbyname(const char *name, SilcBool prefer_ipv6, + char *address, SilcUInt32 address_len); /****f* silcutil/SilcNetAPI/silc_net_gethostbyname_async * @@ -380,9 +553,9 @@ void silc_net_gethostbyname_async(const char *name, * SYNOPSIS * * SilcBool silc_net_gethostbyaddr(const char *addr, char *name, - * SilcUInt32 name_len); + * SilcUInt32 name_len); * - * DESCRIPTION +x * DESCRIPTION * * Resolves the hostname for the IP address indicated by the `addr' * This returns TRUE and the resolved hostname to the `name' buffer, @@ -390,7 +563,8 @@ void silc_net_gethostbyname_async(const char *name, * This is synchronous function and will block the calling process. * ***/ -SilcBool silc_net_gethostbyaddr(const char *addr, char *name, SilcUInt32 name_len); +SilcBool silc_net_gethostbyaddr(const char *addr, char *name, + SilcUInt32 name_len); /****f* silcutil/SilcNetAPI/silc_net_gethostbyaddr_async * @@ -418,7 +592,8 @@ void silc_net_gethostbyaddr_async(const char *addr, * * SYNOPSIS * - * SilcBool silc_net_check_host_by_sock(int sock, char **hostname, char **ip); + * SilcBool silc_net_check_host_by_sock(SilcSocket sock, char **hostname, + * char **ip); * * DESCRIPTION * @@ -426,13 +601,15 @@ void silc_net_gethostbyaddr_async(const char *addr, * lookup as well to verify that the IP has FQDN. * ***/ -SilcBool silc_net_check_host_by_sock(int sock, char **hostname, char **ip); +SilcBool silc_net_check_host_by_sock(SilcSocket sock, char **hostname, + char **ip); /****f* silcutil/SilcNetAPI/silc_net_check_local_by_sock * * SYNOPSIS * - * SilcBool silc_net_check_local_by_sock(int sock, char **hostname, char **ip); + * SilcBool silc_net_check_local_by_sock(SilcSocket sock, char **hostname, + * char **ip); * * DESCRIPTION * @@ -440,33 +617,34 @@ SilcBool silc_net_check_host_by_sock(int sock, char **hostname, char **ip); * lookup as well to verify that the IP has FQDN. * ***/ -SilcBool silc_net_check_local_by_sock(int sock, char **hostname, char **ip); +SilcBool silc_net_check_local_by_sock(SilcSocket sock, char **hostname, + char **ip); /****f* silcutil/SilcNetAPI/silc_net_get_remote_port * * SYNOPSIS * - * SilcUInt16 silc_net_get_remote_port(int sock); + * SilcUInt16 silc_net_get_remote_port(SilcSocket sock); * * DESCRIPTION * * Return remote port by socket. * ***/ -SilcUInt16 silc_net_get_remote_port(int sock); +SilcUInt16 silc_net_get_remote_port(SilcSocket sock); /****f* silcutil/SilcNetAPI/silc_net_get_local_port * * SYNOPSIS * - * SilcUInt16 silc_net_get_local_port(int sock); + * SilcUInt16 silc_net_get_local_port(SilcSocket sock); * * DESCRIPTION * * Return local port by socket. * ***/ -SilcUInt16 silc_net_get_local_port(int sock); +SilcUInt16 silc_net_get_local_port(SilcSocket sock); /****f* silcutil/SilcNetAPI/silc_net_localhost * @@ -497,49 +675,6 @@ char *silc_net_localhost(void); ***/ char *silc_net_localip(void); -/****f* silcutil/SilcNetAPI/silc_net_win32_init - * - * SYNOPSIS - * - * SilcBool silc_net_win32_init(void); - * - * DESCRIPTION - * - * This is WIN32 system specific function and is used to initialize - * the network. This must be called by all WIN32 applications. It - * is usually called at the application's main() or WinMain() before - * calling any other SILC routine. The application must also call - * the silc_net_win32_uninit when exiting the application. Returns - * FALSE on error. The network will not work if this function returns - * FALSE. - * - * NOTES - * - * This routines is available only on Win32 platform. - * - ***/ -SilcBool silc_net_win32_init(void); - -/****f* silcutil/SilcNetAPI/silc_net_win32_uninit - * - * SYNOPSIS - * - * void silc_net_win32_init(void); - * - * DESCRIPTION - * - * This is WIN32 system specific function and is used to uninitialize - * the network. This must be called by all WIN32 applications. It - * is usually called when the application is exiting. After calling - * this function the SILC Net API routines will not work anymore. - * - * NOTES - * - * This routines is available only on Win32 platform. - * - ***/ -void silc_net_win32_uninit(void); - #include "silcnet_i.h" #endif /* SILCNET_H */