Author: Pekka Riikonen <priikone@silcnet.org>
- 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
*/
-/****h* silcutil/SilcNetAPI
+/****h* silcutil/SILC Net Interface
*
* DESCRIPTION
*
*
* SYNOPSIS
*
- * bool silc_net_addr2bin(const char *addr, void *bin, uint32 bin_len);
+ * bool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len);
*
* DESCRIPTION
*
* IPv4 or IPv6 address.
*
***/
-bool silc_net_addr2bin(const char *addr, void *bin, uint32 bin_len);
+bool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len);
/****f* silcutil/SilcNetAPI/SilcNetResolveCallback
*
*
* SYNOPSIS
*
- * bool silc_net_gethostbyname(const char *name, char *address,
- * uint32 address_len);
+ * 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 `host'.
- * This returns TRUE and the IP address of the host, or FALSE
- * if the address could not be resolved. This is synchronous
- * function and will block the calling process.
+ * 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_gethostbyname(const char *name, char *address,
- uint32 address_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 `host'. This function returns immediately, and the
+ * 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);
* SYNOPSIS
*
* bool silc_net_gethostbyaddr(const char *addr, char *name,
- * uint32 name_len);
+ * SilcUInt32 name_len);
*
* DESCRIPTION
*
* Resolves the hostname for the IP address indicated by the `addr'
- * This returns TRUE and the resolved hostname, or FALSE on error.
- * The `addr' may be either IPv4 or IPv6 address. This is
- * synchronous function and will block the calling process.
+ * 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, uint32 name_len);
+bool silc_net_gethostbyaddr(const char *addr, char *name, SilcUInt32 name_len);
/****f* silcutil/SilcNetAPI/silc_net_gethostbyaddr_async
*
*
* 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
*
*
* 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(void);
*
* DESCRIPTION
*
- * Return IP of localhost.
+ * Return IP of localhost. The caller must free the returned IP.
*
***/
char *silc_net_localip(void);
-#ifdef WIN32
-
/****f* silcutil/SilcNetAPI/silc_net_win32_init
*
* SYNOPSIS
* 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);
* 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