X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspsocket.h;h=f945c4f9ddba6a40e739ff95da7fcc7b24482a51;hb=7a7fb7167c0e96509523c378e776cf38418cd4e5;hp=3e65bf677f07606860d2420f38c4355a60579608;hpb=d7324a55fab95b4f51672b701f2dd9cc0836abf8;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspsocket.h b/include/inspsocket.h index 3e65bf677..f945c4f9d 100644 --- a/include/inspsocket.h +++ b/include/inspsocket.h @@ -2,7 +2,7 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team + * InspIRCd: (C) 2002-2008 InspIRCd Development Team * See: http://www.inspircd.org/wiki/index.php/Credits * * This program is free but copyrighted software; see @@ -14,26 +14,46 @@ #ifndef __INSP_SOCKET_H__ #define __INSP_SOCKET_H__ -#include -#include -#include -#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_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, I_ERR_NOMOREFDS }; +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 +}; -class InspSocket; +/* Required forward declarations */ +class BufferedSocket; class InspIRCd; using irc::sockets::insp_sockaddr; @@ -43,52 +63,72 @@ using irc::sockets::insp_aton; /** Used to time out socket connections */ -class CoreExport SocketTimeout : public InspTimer +class CoreExport SocketTimeout : public Timer { private: - InspSocket* sock; + /** 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: - 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) { }; + /** 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 CoreExport InspSocket : public EventHandler +class CoreExport BufferedSocket : public EventHandler { public: + /** Bind IP + */ std::string cbindip; - bool IsIOHooked; - + /** Instance we were created by + */ InspIRCd* Instance; + /** Timeout class or NULL + */ SocketTimeout* Timeout; + /** Timeout length + */ unsigned long timeout_val; + /** Socket output buffer (binary safe) + */ std::deque outbuffer; - /** - * The hostname connected to + /** The hostname connected to */ char host[MAXBUF]; - /** - * The port connected to, or the port - * this socket is listening on + /** The port connected to */ int port; @@ -97,22 +137,7 @@ class CoreExport InspSocket : public EventHandler * listening, connecting, connected * or error. */ - InspSocketState state; - - /** - * This value is true if the - * socket has timed out. - */ - bool timeout; - - /** - * 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. - */ - char ibuf[65535]; + BufferedSocketState state; /** * The IP address being connected @@ -128,6 +153,7 @@ class CoreExport InspSocket : public EventHandler socklen_t length; /** Flushes the write buffer + * @returns true if the writing failed, false if it was successful */ bool FlushWriteBuffer(); @@ -145,44 +171,41 @@ class CoreExport InspSocket : public EventHandler */ 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); /** * The default constructor does nothing * and should not be used. */ - InspSocket(InspIRCd* SI); + 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(InspIRCd* SI, 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. + * 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 InspSocket. To do so, + * 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 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(InspIRCd* SI, const std::string &ipaddr, int port, bool listening, unsigned long maxtime, const std::string &connectbindip = ""); + BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int port, unsigned long maxtime, const std::string &connectbindip = ""); /** * This method is called when an outbound @@ -197,7 +220,7 @@ class CoreExport InspSocket : public EventHandler * 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, @@ -214,12 +237,31 @@ class CoreExport InspSocket : public EventHandler * 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 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 @@ -238,9 +280,7 @@ class CoreExport InspSocket : public EventHandler * 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(); @@ -249,7 +289,7 @@ class CoreExport InspSocket : public EventHandler * 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 @@ -263,29 +303,14 @@ class CoreExport InspSocket : public EventHandler * 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); + void SetState(BufferedSocketState s); /** * Call this to receive the next write event @@ -297,25 +322,18 @@ class CoreExport InspSocket : public EventHandler /** * 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. */ 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(); - /** * This method causes the socket to close, and may * also be triggered by other methods such as OnTimeout @@ -328,26 +346,22 @@ class CoreExport InspSocket : public EventHandler * will close() and shutdown() the file descriptor * used for this socket. */ - virtual ~InspSocket(); + virtual ~BufferedSocket(); /** * This method attempts to connect to a hostname. - * This only occurs on a non-listening socket. This - * method is asyncronous. + * This method is asyncronous. */ 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 MarkAsClosed(); - void HandleEvent(EventType et, int errornum = 0); + /** Returns true if this socket is readable + */ bool Readable(); }; #endif +