X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilcnet.h;h=062eddfd1cbcd2cf7531af684a16b1912e1df49e;hb=d1e71f42379e8b5cd0748a7aeae8561b02cfe53d;hp=4c966eab54b9ad9eea621b2c4b5f0517a6ca7f09;hpb=0fd8b4134368dc548b9de997cd84f1cbc076c8f7;p=silc.git diff --git a/lib/silcutil/silcnet.h b/lib/silcutil/silcnet.h index 4c966eab..062eddfd 100644 --- a/lib/silcutil/silcnet.h +++ b/lib/silcutil/silcnet.h @@ -4,12 +4,11 @@ Author: Pekka Riikonen - Copyright (C) 1997 - 2001 Pekka Riikonen + Copyright (C) 1997 - 2005 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 - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. + the Free Software Foundation; version 2 of the License. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of @@ -18,7 +17,7 @@ */ -/****h* silcutil/SilcNetAPI +/****h* silcutil/SILC Net Interface * * DESCRIPTION * @@ -31,7 +30,7 @@ * calling the silc_net_win32_uninit function. The initializing must be * done in order to assure that the SILC Net API works correctly. * - */ + ***/ #ifndef SILCNET_H #define SILCNET_H @@ -53,7 +52,7 @@ * the created socket or -1 on error. * ***/ -int silc_net_create_server(int port, char *ip_addr); +int silc_net_create_server(int port, const char *ip_addr); /****f* silcutil/SilcNetAPI/silc_net_close_server * @@ -177,6 +176,32 @@ int silc_net_set_socket_opt(int sock, int level, int option, int on); int silc_net_get_socket_opt(int sock, int level, int option, void *optval, int *opt_len); +/****f* silcutil/SilcNetAPI/silc_net_is_ip4 + * + * SYNOPSIS + * + * bool silc_net_is_ip4(const char *addr); + * + * DESCRIPTION + * + * Checks whether IP address sent as argument is valid IPv4 address. + * + ***/ +bool silc_net_is_ip4(const char *addr); + +/****f* silcutil/SilcNetAPI/silc_net_is_ip6 + * + * SYNOPSIS + * + * bool silc_net_is_ip6(const char *addr); + * + * DESCRIPTION + * + * Checks whether IP address sent as argument is valid IPv6 address. + * + ***/ +bool silc_net_is_ip6(const char *addr); + /****f* silcutil/SilcNetAPI/silc_net_is_ip * * SYNOPSIS @@ -186,6 +211,7 @@ int silc_net_get_socket_opt(int sock, int level, int option, * DESCRIPTION * * Checks whether IP address sent as argument is valid IP address. + * This supports both IPv4 and IPv6 addresses. * ***/ bool silc_net_is_ip(const char *addr); @@ -194,17 +220,120 @@ bool silc_net_is_ip(const char *addr); * * SYNOPSIS * - * bool silc_net_addr2bin(const char *addr, unsigned char *bin, - * uint32 bin_len); + * bool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len); * * DESCRIPTION * * Converts the IP number string from numbers-and-dots notation to - * binary form. + * binary form in network byte order. The address can be either + * IPv4 or IPv6 address. + * + ***/ +bool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len); + +/****f* silcutil/SilcNetAPI/SilcNetResolveCallback + * + * SYNOPSIS + * + * typedef void (*SilcNetResolveCallback)(const char *result, + * void *context); + * + * DESCRIPTION + * + * A callback function of this type is called after the asynchronous + * resolving operation has been completed. This callback is used + * when asynchronously resolving IP addresses and hostnames. + * + ***/ +typedef void (*SilcNetResolveCallback)(const char *result, void *context); + +/****f* silcutil/SilcNetAPI/silc_net_gethostbyname + * + * SYNOPSIS + * + * bool silc_net_gethostbyname(const char *name, bool prefer_ipv6, + * char *address, SilcUInt32 address_len); + * + * DESCRIPTION + * + * Resolves the IP address of the hostname indicated by the `name'. + * This returns TRUE and the IP address of the host to the `address' + * buffer, or FALSE if the address could not be resolved. This is + * synchronous function and will block the calling process. If the + * `prefer_ipv6' is TRUE then this will return IPv6 address if it + * finds. If FALSE if returns IPv4 address even if it found IPv6 + * address also. * ***/ -bool silc_net_addr2bin(const char *addr, unsigned char *bin, - uint32 bin_len); +bool silc_net_gethostbyname(const char *name, bool prefer_ipv6, char *address, + SilcUInt32 address_len); + +/****f* silcutil/SilcNetAPI/silc_net_gethostbyname_async + * + * SYNOPSIS + * + * void silc_net_gethostbyname_async(const char *name, + * bool prefer_ipv6, + * SilcSchedule schedule, + * SilcNetResolveCallback completion, + * void *context) + * + * DESCRIPTION + * + * Asynchronously resolves the IP address of the hostname indicated + * by the `name'. This function returns immediately, and the + * `completion' callback will be called after the resolving is + * completed. + * + * If the `prefer_ipv6' is TRUE then this will return IPv6 address if it + * finds. If FALSE if returns IPv4 address even if it found IPv6 + * address also. + * + ***/ +void silc_net_gethostbyname_async(const char *name, + bool prefer_ipv6, + SilcSchedule schedule, + SilcNetResolveCallback completion, + void *context); + +/****f* silcutil/SilcNetAPI/silc_net_gethostbyaddr + * + * SYNOPSIS + * + * bool silc_net_gethostbyaddr(const char *addr, char *name, + * SilcUInt32 name_len); + * + * DESCRIPTION + * + * Resolves the hostname for the IP address indicated by the `addr' + * This returns TRUE and the resolved hostname to the `name' buffer, + * or FALSE on error. The `addr' may be either IPv4 or IPv6 address. + * This is synchronous function and will block the calling process. + * + ***/ +bool silc_net_gethostbyaddr(const char *addr, char *name, SilcUInt32 name_len); + +/****f* silcutil/SilcNetAPI/silc_net_gethostbyaddr_async + * + * SYNOPSIS + * + * void silc_net_gethostbyaddr_async(const char *addr, + * SilcSchedule schedule, + * SilcNetResolveCallback completion, + * void *context) + * + * DESCRIPTION + * + * Asynchronously resolves the hostname for the IP address indicated + * by the `addr'. This function returns immediately, and the + * `completion' callback will be called after the resolving is + * completed. + * + ***/ +void silc_net_gethostbyaddr_async(const char *addr, + SilcSchedule schedule, + SilcNetResolveCallback completion, + void *context); /****f* silcutil/SilcNetAPI/silc_net_check_host_by_sock * @@ -238,44 +367,56 @@ bool silc_net_check_local_by_sock(int sock, char **hostname, char **ip); * * SYNOPSIS * - * uint16 silc_net_get_remote_port(int sock); + * SilcUInt16 silc_net_get_remote_port(int sock); * * DESCRIPTION * * Return remote port by socket. * ***/ -uint16 silc_net_get_remote_port(int sock); +SilcUInt16 silc_net_get_remote_port(int sock); /****f* silcutil/SilcNetAPI/silc_net_get_local_port * * SYNOPSIS * - * uint16 silc_net_get_local_port(int sock); + * SilcUInt16 silc_net_get_local_port(int sock); * * DESCRIPTION * * Return local port by socket. * ***/ -uint16 silc_net_get_local_port(int sock); +SilcUInt16 silc_net_get_local_port(int sock); /****f* silcutil/SilcNetAPI/silc_net_localhost * * SYNOPSIS * - * char *silc_net_localhost(); + * char *silc_net_localhost(void); * * DESCRIPTION * * Return name of localhost. This will also attempt to resolve * the real hostname by the local host's IP address. If unsuccessful - * the first found hostname is returned. + * the first found hostname is returned. The caller must free + * returned hostname. * ***/ -char *silc_net_localhost(); +char *silc_net_localhost(void); -#ifdef WIN32 +/****f* silcutil/SilcNetAPI/silc_net_localip + * + * SYNOPSIS + * + * char *silc_net_localip(void) + * + * DESCRIPTION + * + * Return IP of localhost. The caller must free the returned IP. + * + ***/ +char *silc_net_localip(void); /****f* silcutil/SilcNetAPI/silc_net_win32_init * @@ -293,6 +434,10 @@ char *silc_net_localhost(); * FALSE on error. The network will not work if this function returns * FALSE. * + * NOTES + * + * This routines is available only on Win32 platform. + * ***/ bool silc_net_win32_init(void); @@ -309,9 +454,11 @@ bool silc_net_win32_init(void); * 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); #endif - -#endif