Integer type name change.

[silc.git] / lib / silcutil / silcnet.h

diff --git a/lib/silcutil/silcnet.h b/lib/silcutil/silcnet.h
index b9978d6e9a16fd093688d756dba194ad0c76c47c..931b3d82fe38aa3554d5eab688f97250ba51ff90 100644 (file)
--- a/lib/silcutil/silcnet.h
+++ b/lib/silcutil/silcnet.h
@@ -177,6 +177,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 +212,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,16 +221,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 in network byte order.
+ *    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_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.
  *
  ***/
-bool silc_net_addr2bin(const char *addr, void *bin, uint32 bin_len);
+void silc_net_gethostbyaddr_async(const char *addr, 
+                                 SilcSchedule schedule,
+                                 SilcNetResolveCallback completion,
+                                 void *context);
 
 /****f* silcutil/SilcNetAPI/silc_net_check_host_by_sock
  *
@@ -237,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
  *