X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspsocket.h;h=af93baa56f409fec74bcaa6e50ffa3ce9593b0e2;hb=99a1ea0892b575c6d66d9f4c0aab5042c261ce4a;hp=9858f043244034254eb4f71216337096b9966495;hpb=13153694df045d24217658077c7d223d269504b5;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspsocket.h b/include/inspsocket.h index 9858f0432..af93baa56 100644 --- a/include/inspsocket.h +++ b/include/inspsocket.h @@ -2,14 +2,11 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. + * InspIRCd: (C) 2002-2008 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. * * --------------------------------------------------- */ @@ -17,49 +14,127 @@ #ifndef __INSP_SOCKET_H__ #define __INSP_SOCKET_H__ -#include -#include -#include -#include "inspircd_config.h" -#include "dns.h" -#include "socket.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 BufferedSocketState +{ + /** 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 BufferedSocketError +{ + /** 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 BufferedSocket; +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 Timer +{ + private: + /** BufferedSocket the class is attached to + */ + BufferedSocket* 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 BufferedSocket + * @pram Instance server instance to attach to + * @param thesock BufferedSocket to attach to + * @param secs_from_now Seconds from now to time out + * @param now The current time + */ + SocketTimeout(int fd, InspIRCd* Instance, BufferedSocket* thesock, long secs_from_now, time_t now) : Timer(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 + * BufferedSocket is an extendable socket class which modules * can use for TCP socket support. It is fully integrated * into InspIRCds socket loop and attaches its sockets to * the core's instance of the SocketEngine class, meaning * that any sockets you create have the same power and * abilities as a socket created by the core itself. - * To use InspSocket, you must inherit a class from it, - * and use the InspSocket constructors to establish connections + * To use BufferedSocket, you must inherit a class from it, + * and use the BufferedSocket constructors to establish connections * and bindings. */ -class InspSocket +class CoreExport BufferedSocket : public EventHandler { -protected: + public: - std::deque 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 + */ + SocketTimeout* Timeout; + + /** + * Timeout length + */ + unsigned long timeout_val; + + /** + * Socket output buffer (binary safe) */ - DNS dns; + std::deque outbuffer; /** * The hostname connected to @@ -77,36 +152,17 @@ protected: * listening, connecting, connected * or error. */ - 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; + BufferedSocketState state; /** * This value is true if the * socket has timed out. */ - bool timeout; + bool timeout; /** * Socket input buffer, used by read(). The class which - * extends InspSocket is expected to implement an extendable + * extends BufferedSocket is expected to implement an extendable * buffer which can grow much larger than 64k, * this buffer is just designed to be temporary storage. * space. @@ -120,18 +176,6 @@ protected: */ 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 @@ -162,38 +206,43 @@ protected: */ bool WaitingForWriteEvent; - bool BindAddr(); - -public: + /** + * 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(); + BufferedSocket(InspIRCd* SI); /** * This constructor is used to associate - * an existing connecting with an InspSocket + * an existing connecting with an BufferedSocket * class. The given file descriptor must be - * valid, and when initialized, the InspSocket + * valid, and when initialized, the BufferedSocket * will be set with the given IP address * and placed in CONNECTED state. */ - InspSocket(int newfd, const char* ip); + BufferedSocket(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 BufferedSocket. 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); + BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int port, bool listening, unsigned long maxtime, const std::string &connectbindip = ""); /** * This method is called when an outbound @@ -208,7 +257,7 @@ public: * however errors also generate close events. * @param e The error type which occured */ - virtual void OnError(InspSocketError e); + virtual void OnError(BufferedSocketError e); /** * When an established connection is terminated, @@ -225,11 +274,20 @@ public: * the socket engine. If you return false from this * function, the core removes your socket from its * list and erases it from the socket engine, then - * calls InspSocket::Close() and deletes it. + * calls BufferedSocket::Close() and deletes it. * @return false to close the socket */ 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(); /** @@ -260,7 +318,7 @@ public: * into a char* array which can be up to * 16 kilobytes in length. */ - virtual char* Read(); + virtual const char* Read(); /** * Returns the IP address associated with @@ -269,20 +327,12 @@ public: */ 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. * @param data The data to send */ - virtual int Write(const std::string &data); + virtual void Write(const std::string &data); /** * If your socket is a listening socket, when a new @@ -304,7 +354,7 @@ public: * to change socket states, and you should not call * it directly. */ - void SetState(InspSocketState s); + void SetState(BufferedSocketState s); /** * Call this to receive the next write event @@ -316,13 +366,13 @@ public: /** * Returns the current socket state. */ - InspSocketState GetState(); + BufferedSocketState GetState(); /** * Only the core should call this function. * When called, it is assumed the socket is ready * to read data, and the method call routes the - * event to the various methods of InspSocket + * event to the various methods of BufferedSocket * for you to handle. This can also cause the * socket's state to change. */ @@ -347,15 +397,7 @@ public: * will close() and shutdown() the file descriptor * used for this socket. */ - 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(); + virtual ~BufferedSocket(); /** * This method attempts to connect to a hostname. @@ -364,13 +406,14 @@ public: */ virtual bool DoConnect(); - /** - * This method marks the socket closed. - * The next time the core examines a socket marked - * as closed, the socket will be closed and the - * memory reclaimed. + /** Handle event from EventHandler parent class + */ + void HandleEvent(EventType et, int errornum = 0); + + /** Returns true if this socket is readable */ - void MarkAsClosed(); + bool Readable(); }; #endif +