-/****h* silcutil/silcnet.h
- *
- * NAME
- *
- * silcnet.h
- *
- * COPYRIGHT
- *
- * Author: Pekka Riikonen <priikone@silcnet.org>
+/*
+
+ silcnet.h
+
+ Author: Pekka Riikonen <priikone@silcnet.org>
+
+ Copyright (C) 1997 - 2001 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.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+*/
+
+/****h* silcutil/SilcNetAPI
*
- * Copyright (C) 1997 - 2001 Pekka Riikonen
+ * DESCRIPTION
*
- * 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.
+ * 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.
*
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * 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.
*
*/
***/
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