X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspsocket.h;h=32f2dab1a7d9861d7080be243aaa2bb2ccb81737;hb=5d67a5fff127bf95bca69b436ef7f645f2fe3281;hp=1b9947ef9c23707770445ab1066030974b184a28;hpb=a5c9214743e76bd8bee1cb5f4d0d6dc3d1171c58;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspsocket.h b/include/inspsocket.h index 1b9947ef9..32f2dab1a 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-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits + * * This program is free but copyrighted software; see - * the file COPYING for details. + * the file COPYING for details. * * --------------------------------------------------- */ @@ -17,100 +14,123 @@ #ifndef __INSP_SOCKET_H__ #define __INSP_SOCKET_H__ -#include -#include -#include -#include "dns.h" -#include "inspircd_config.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 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 +}; -/** - * InspSocket 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 - * and bindings. +/* Required forward declarations */ +class BufferedSocket; +class InspIRCd; + +/** Used to time out socket connections */ -class InspSocket : public Extensible +class CoreExport SocketTimeout : public Timer { -protected: + private: + /** BufferedSocket the class is attached to + */ + BufferedSocket* sock; - std::deque outbuffer; + /** Server instance creating the timeout class + */ + InspIRCd* ServerInstance; - /** - * The file descriptor of this socket + /** File descriptor of class this is attached to */ - int fd; + int sfd; - /** - * The resolver for this socket + 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) { }; - /** - * The hostname connected to + /** Handle tick event */ - char host[MAXBUF]; + virtual void Tick(time_t now); +}; - /** - * The port connected to, or the port - * this socket is listening on +/** + * 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 all use is fully asynchronous. + * + * To use BufferedSocket, you must inherit a class from it. + */ +class CoreExport BufferedSocket : public EventHandler +{ + public: + + /** Bind IP */ - int port; + std::string cbindip; - /** - * The state for this socket, either - * listening, connecting, connected - * or error. + /** Instance we were created by */ - InspSocketState state; + InspIRCd* ServerInstance; - /** - * The host being connected to, - * in sockaddr form + /** Timeout class or NULL */ - insp_sockaddr addr; + SocketTimeout* Timeout; - /** - * The host being connected to, - * in in_addr form + /** Socket output buffer (binary safe) */ - insp_inaddr addy; + std::deque outbuffer; - /** - * When this time is reached, - * the socket times out if it is - * in the CONNECTING state + /** The hostname connected to */ - time_t timeout_end; + char host[MAXBUF]; - /** - * This value is true if the - * socket has timed out. + /** The port connected to */ - bool timeout; - + int port; + /** - * Socket input buffer, used by read(). The class which - * extends InspSocket is expected to implement an extendable - * buffer which can grow much larger than 64k, - * this buffer is just designed to be temporary storage. - * space. + * The state for this socket, either + * listening, connecting, connected + * or error. */ - char ibuf[65535]; + BufferedSocketState state; /** * The IP address being connected @@ -119,18 +139,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 @@ -138,6 +146,7 @@ protected: socklen_t length; /** Flushes the write buffer + * @returns true if the writing failed, false if it was successful */ bool FlushWriteBuffer(); @@ -147,7 +156,7 @@ protected: * more information without application-level queueing * which was required in older software. */ - void SetQueues(int nfd); + void SetQueues(); /** When the socket has been marked as closing, this flag * will be set to true, then the next time the socket is @@ -155,44 +164,45 @@ protected: */ bool ClosePending; - /** 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. + /** + * Bind to an address + * @param ip IP to bind to + * @return True is the binding succeeded */ - bool WaitingForWriteEvent; + bool BindAddr(const std::string &ip); - bool BindAddr(); - -public: + /** (really) Try bind to a given IP setup. For internal use only. + */ + bool DoBindMagic(const std::string ¤t_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 - * @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 + * This constructor is used to create a new outbound connection to another host. + * 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 * @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, unsigned long maxtime, const std::string &connectbindip = ""); /** * This method is called when an outbound @@ -207,7 +217,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, @@ -224,12 +234,31 @@ 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(); - virtual bool OnWriteReady(); + /** + * 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 SocketEngine::WantWrite(). + * + * The default behaviour of this method is to + * flush the write buffer, respecting the IO + * hooking modules. + * + * XXX: this used to be virtual, ask us if you need it to be so. + * @return false to close the socket + */ + bool OnWriteReady(); /** * When an outbound connection fails, and the @@ -248,9 +277,7 @@ public: * Whenever close() is called, OnClose() will be * called first. Please note that this means * OnClose will be called alongside OnError(), - * OnTimeout(), and Close(), and also when - * cancelling a listening socket by calling - * the destructor indirectly. + * OnTimeout(), and Close(). */ virtual void OnClose(); @@ -259,7 +286,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 @@ -268,71 +295,28 @@ 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); - - /** - * If your socket is a listening socket, when a new - * connection comes in on the socket this method will - * be called. Given the new file descriptor in the - * parameters, and the IP, it is recommended you copy - * them to a new instance of your socket class, - * e.g.: - * - * MySocket* newsocket = new MySocket(newfd,ip); - * - * Once you have done this, you can then associate the - * new socket with the core using Server::AddSocket(). - */ - virtual int OnIncomingConnection(int newfd, char* ip); + virtual void Write(const std::string &data); /** * Changes the socket's state. The core uses this * to change socket states, and you should not call * it directly. */ - void SetState(InspSocketState s); - - /** - * Call this to receive the next write event - * that comes along for this fd to the OnWriteReady - * method. - */ - void WantWrite(); + void SetState(BufferedSocketState s); /** * 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 - * for you to handle. This can also cause the - * socket's state to change. + /** Mark a socket as being connected and call appropriate events. */ - bool Poll(); - - /** - * This method returns the socket's file descriptor - * as assigned by the operating system, or -1 - * if no descriptor has been assigned. - */ - int GetFd(); + bool InternalMarkConnected(); /** * This method causes the socket to close, and may @@ -346,30 +330,22 @@ public: * will close() and shutdown() the file descriptor * used for this socket. */ - virtual ~InspSocket(); + virtual ~BufferedSocket(); /** - * 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. + * This method attempts to connect to a hostname. + * This method is asyncronous. + * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated */ - virtual bool DoResolve(); + virtual bool DoConnect(unsigned long maxtime); - /** - * This method attempts to connect to a hostname. - * This only occurs on a non-listening socket. This - * method is asyncronous. + /** Handle event from EventHandler parent class */ - virtual bool DoConnect(); + void HandleEvent(EventType et, int errornum = 0); - /** - * 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. + /** Returns true if this socket is readable */ - void MarkAsClosed(); + bool Readable(); }; #endif