Integer type name change.
[silc.git] / lib / silcutil / silcnet.h
index 7089acb22a68215fb9ea670963e29e37f4745c1b..931b3d82fe38aa3554d5eab688f97250ba51ff90 100644 (file)
@@ -221,7 +221,7 @@ bool silc_net_is_ip(const char *addr);
  *
  * 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
  *
@@ -230,7 +230,7 @@ bool silc_net_is_ip(const char *addr);
  *    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
  *
@@ -252,38 +252,47 @@ typedef void (*SilcNetResolveCallback)(const char *result, void *context);
  *
  * 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
  *
- *    Asynchronouosly resolves the IP address of the hostname indicated
- *    by the `host'.  This function returns immediately, and the
+ *    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);
@@ -293,17 +302,17 @@ void silc_net_gethostbyname_async(const char *name,
  * 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
  *
@@ -316,7 +325,7 @@ bool silc_net_gethostbyaddr(const char *addr, char *name, uint32 name_len);
  *
  * DESCRIPTION
  *
- *    Asynchronouosly resolves the hostname for the IP address indicated
+ *    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.
@@ -359,27 +368,27 @@ 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
  *