updates.

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

diff --git a/lib/silcutil/silcnet.h b/lib/silcutil/silcnet.h
index 68ef081434fbbc87b268421f02734242fdbc47df..4b1d410a702a8713e40642e0641ee31f93397d1f 100644 (file)
--- a/lib/silcutil/silcnet.h
+++ b/lib/silcutil/silcnet.h
@@ -20,6 +20,17 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
+ * DESCRIPTION
+ *
+ * SILC Net API provides various network routines for applications. It
+ * can be used to create TCP/IP connections and servers. Various utility
+ * functions for resolving various information is also provided.
+ *
+ * On WIN32 systems the SILC Net API must initialized by calling the
+ * silc_net_win32_init and uninitialized when the application ends by
+ * 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
@@ -255,4 +266,43 @@ uint16 silc_net_get_local_port(int sock);
  ***/
 char *silc_net_localhost();
 
+#ifdef WIN32
+
+/****f* silcutil/SilcNetAPI/silc_net_win32_init
+ *
+ * SYNOPSIS
+ *
+ *    bool 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.
+ *
+ ***/
+bool 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.
+ *
+ ***/
+void silc_net_win32_uninit(void);
+
+#endif
+
 #endif