* | 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.
+ * the file COPYING for details.
*
* ---------------------------------------------------
*/
#include <sstream>
#include <string>
#include <deque>
-#include "inspircd_config.h"
#include "dns.h"
+#include "inspircd_config.h"
#include "socket.h"
+#include "inspsocket.h"
+#include "timer.h"
/**
* States which a socket may be in
*/
-enum InspSocketState { I_DISCONNECTED, I_RESOLVING, I_CONNECTING, I_CONNECTED, I_LISTENING, I_ERROR };
+enum InspSocketState
+{
+ /** Socket disconnected */
+ I_DISCONNECTED,
+ /** Socket connecting */
+ I_CONNECTING,
+ /** Socket fully connected */
+ I_CONNECTED,
+ /** Socket listening for connections */
+ I_LISTENING,
+ /** Socket has an error */
+ I_ERROR
+};
/**
* Error types which a socket may exhibit
*/
-enum InspSocketError { I_ERR_TIMEOUT, I_ERR_SOCKET, I_ERR_CONNECT, I_ERR_BIND, I_ERR_RESOLVE, I_ERR_WRITE };
+enum InspSocketError
+{
+ /** Socket connect timed out */
+ I_ERR_TIMEOUT,
+ /** Socket could not be created */
+ I_ERR_SOCKET,
+ /** Socket could not connect (refused) */
+ I_ERR_CONNECT,
+ /** Socket could not bind to local port/ip */
+ I_ERR_BIND,
+ /** Socket could not reslve host (depreciated) */
+ I_ERR_RESOLVE,
+ /** Socket could not write data */
+ I_ERR_WRITE,
+ /** No more file descriptors left to create socket! */
+ I_ERR_NOMOREFDS
+};
+
+/* Required forward declarations */
+class InspSocket;
+class InspIRCd;
+
+using irc::sockets::insp_sockaddr;
+using irc::sockets::insp_inaddr;
+using irc::sockets::insp_ntoa;
+using irc::sockets::insp_aton;
+
+/** Used to time out socket connections
+ */
+class CoreExport SocketTimeout : public InspTimer
+{
+ private:
+ /** InspSocket the class is attached to
+ */
+ InspSocket* sock;
+ /** Server instance creating the timeout class
+ */
+ InspIRCd* ServerInstance;
+ /** File descriptor of class this is attached to
+ */
+ int sfd;
+ public:
+ /** Create a socket timeout class
+ * @param fd File descriptor of InspSocket
+ * @pram Instance server instance to attach to
+ * @param thesock InspSocket to attach to
+ * @param secs_from_now Seconds from now to time out
+ * @param now The current time
+ */
+ SocketTimeout(int fd, InspIRCd* Instance, InspSocket* thesock, long secs_from_now, time_t now) : InspTimer(secs_from_now, now), sock(thesock), ServerInstance(Instance), sfd(fd) { };
+ /** Handle tick event
+ */
+ virtual void Tick(time_t now);
+};
/**
* InspSocket is an extendable socket class which modules
* and use the InspSocket constructors to establish connections
* and bindings.
*/
-class InspSocket
+class CoreExport InspSocket : public EventHandler
{
-private:
+ public:
- std::deque<std::string> outbuffer;
+ /**
+ * Bind IP
+ */
+ std::string cbindip;
- /**
- * The file descriptor of this socket
+ /**
+ * Is hooked by a module for low level IO
*/
- int fd;
+ bool IsIOHooked;
- /**
- * The resolver for this socket
+ /**
+ * Instance we were created by
+ */
+ InspIRCd* Instance;
+
+ /**
+ * Timeout class or NULL
*/
- DNS dns;
+ SocketTimeout* Timeout;
+
+ /**
+ * Timeout length
+ */
+ unsigned long timeout_val;
+
+ /**
+ * Socket output buffer (binary safe)
+ */
+ std::deque<std::string> outbuffer;
/**
* The hostname connected to
*/
InspSocketState state;
- /**
- * The host being connected to,
- * in sockaddr form
- */
- insp_sockaddr addr;
-
- /**
- * The host being connected to,
- * in in_addr form
- */
- insp_inaddr addy;
-
- /**
- * When this time is reached,
- * the socket times out if it is
- * in the CONNECTING state
- */
- time_t timeout_end;
-
/**
* This value is true if the
* socket has timed out.
*/
- bool timeout;
+ bool timeout;
/**
* Socket input buffer, used by read(). The class which
*/
char IP[MAXBUF];
- /**
- * Client sockaddr structure used
- * by accept()
- */
- insp_sockaddr client;
-
- /**
- * Server sockaddr structure used
- * by accept()
- */
- insp_sockaddr server;
-
/**
* Used by accept() to indicate the
* sizes of the sockaddr_in structures
*/
bool ClosePending;
-public:
+ /** Set to true when we're waiting for a write event.
+ * If this is true and a write event comes in, we
+ * call the write instead of the read method.
+ */
+ bool WaitingForWriteEvent;
+
+ /**
+ * Bind to an address
+ * @param ip IP to bind to
+ * @return True is the binding succeeded
+ */
+ bool BindAddr(const std::string &ip);
/**
* The default constructor does nothing
* and should not be used.
*/
- InspSocket();
+ InspSocket(InspIRCd* SI);
/**
* This constructor is used to associate
* will be set with the given IP address
* and placed in CONNECTED state.
*/
- InspSocket(int newfd, char* ip);
+ InspSocket(InspIRCd* SI, int newfd, const char* ip);
/**
* This constructor is used to create a new
* socket, either listening for connections, or an outbound connection to another host.
- * Note that if you specify a hostname in the 'host' parameter, then there will be an extra
- * step involved (a nonblocking DNS lookup) which will cause your connection to be established
- * slower than if it was an IP. Therefore, use an IP address where it is available instead.
- * @param host The hostname to connect to, or bind to
+ * Note that if you specify a hostname in the 'ipaddr' parameter, this class will not
+ * connect. You must resolve your hostnames before passing them to InspSocket. To do so,
+ * you should use the nonblocking class 'Resolver'.
+ * @param ipaddr The IP to connect to, or bind to
* @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
+ * @param connectbindip When creating an outbound connection, the IP to bind the connection to. If not defined, the port is not bound.
+ * @return On exit, GetState() returns I_ERROR if an error occured, and errno can be used to read the socket error.
*/
- InspSocket(const std::string &host, int port, bool listening, unsigned long maxtime);
+ InspSocket(InspIRCd* SI, const std::string &ipaddr, int port, bool listening, unsigned long maxtime, const std::string &connectbindip = "");
/**
* This method is called when an outbound
*/
virtual bool OnDataReady();
+ /**
+ * When it is ok to write to the socket, and a
+ * write event was requested, this method is
+ * triggered. Within this method you should call
+ * write() or send() etc, to send data to the
+ * other end of the socket. Further write events
+ * will not be triggered unless you call WantWrite().
+ * @return false to close the socket
+ */
+ virtual bool OnWriteReady();
+
/**
* When an outbound connection fails, and the
* attempt times out, you will receive this event.
*/
std::string GetIP();
- /**
- * This function checks if the socket has
- * timed out yet, given the current time
- * in the parameter.
- * @return true if timed out, false if not timed out
- */
- bool Timeout(time_t current);
-
/**
* Writes a std::string to the socket. No carriage
* returns or linefeeds are appended to the string.
*/
void SetState(InspSocketState s);
+ /**
+ * Call this to receive the next write event
+ * that comes along for this fd to the OnWriteReady
+ * method.
+ */
+ void WantWrite();
+
/**
* Returns the current socket state.
*/
*/
virtual ~InspSocket();
- /**
- * This method attempts to resolve the hostname,
- * if a hostname is given and not an IP,
- * before a connection can occur. This method is
- * asyncronous.
- */
- virtual bool DoResolve();
-
/**
* This method attempts to connect to a hostname.
* This only occurs on a non-listening socket. This
* The next time the core examines a socket marked
* as closed, the socket will be closed and the
* memory reclaimed.
+ *
+ * NOTE: This method is DEPRECIATED and will be
+ * ignored if called!
*/
void MarkAsClosed();
+
+ /** Handle event from EventHandler parent class
+ */
+ void HandleEvent(EventType et, int errornum = 0);
+
+ /** Returns true if this socket is readable
+ */
+ bool Readable();
};
#endif
+
projects / user / henk / code / inspircd.git / blobdiff