Not safe for use yet

[user/henk/code/inspircd.git] / include / inspsocket.h

diff --git a/include/inspsocket.h b/include/inspsocket.h
index 52de46c2da8a38309950a37fcd085c1c013e304a..1a959bd2d61e1da150f0dd05977dccd94457384a 100644 (file)
--- a/include/inspsocket.h
+++ b/include/inspsocket.h
@@ -2,12 +2,9 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
  *
@@ -204,6 +201,7 @@ class InspSocket : public EventHandler
         * @param port The port number to connect to, or bind to
         * @param listening true to listen on the given host:port pair, or false to connect to them
         * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
+        * @return On exit, GetState() returns I_ERROR if an error occured, and errno can be used to read the socket error.
         */
        InspSocket(InspIRCd* SI, const std::string &ipaddr, int port, bool listening, unsigned long maxtime);