Merged silc_1_1_branch to trunk.
[silc.git] / lib / silcutil / silcnet.h
index b2adca7685bc9588a2af940a3483ae0b4b523b78..3bbc40ab665501b7b3c34625d347afcb8408b7a0 100644 (file)
@@ -118,7 +118,7 @@ typedef void (*SilcNetCallback)(SilcNetStatus status,
  *
  *    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
+ *    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.
@@ -156,6 +156,40 @@ silc_net_tcp_create_listener(const char **local_ip_addr,
 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.
+ *
+ ***/
+char **silc_net_listener_get_ip(SilcNetListener listener,
+                               SilcUInt32 *ip_count);
+
+/****f* silcutil/SilcNetAPI/silc_net_listener_get_hostname
+ *
+ * SYNOPSIS
+ *
+ *    char **silc_net_listener_get_hostname(SilcNetListener listener,
+ *                                          SilcUInt32 *hostname_count);
+ *
+ * DESCRIPTION
+ *
+ *    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.
+ *
+ ***/
+char **silc_net_listener_get_hostname(SilcNetListener listener,
+                                     SilcUInt32 *hostname_count);
+
 /****f* silcutil/SilcNetAPI/silc_net_close_listener
  *
  * SYNOPSIS
@@ -305,6 +339,19 @@ 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
+ *
+ *    Return `error' as a string.
+ *
+ ***/
+const char *silc_net_get_error_string(SilcNetStatus error);
+
 /****f* silcutil/SilcNetAPI/silc_net_close_connection
  *
  * SYNOPSIS
@@ -457,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
  *
@@ -506,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,
@@ -628,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 */