X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspsocket.h;h=32f2dab1a7d9861d7080be243aaa2bb2ccb81737;hb=5d67a5fff127bf95bca69b436ef7f645f2fe3281;hp=d165d64f2429285a449a20ec1cf68a13fa7daaeb;hpb=7d78c5c2c0c624bc06d9ea3154bcd772a2786fa8;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspsocket.h b/include/inspsocket.h index d165d64f2..32f2dab1a 100644 --- a/include/inspsocket.h +++ b/include/inspsocket.h @@ -2,8 +2,8 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * 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. @@ -14,19 +14,12 @@ #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 +enum BufferedSocketState { /** Socket disconnected */ I_DISCONNECTED, @@ -34,8 +27,6 @@ enum InspSocketState I_CONNECTING, /** Socket fully connected */ I_CONNECTED, - /** Socket listening for connections */ - I_LISTENING, /** Socket has an error */ I_ERROR }; @@ -43,7 +34,7 @@ enum InspSocketState /** * Error types which a socket may exhibit */ -enum InspSocketError +enum BufferedSocketError { /** Socket connect timed out */ I_ERR_TIMEOUT, @@ -62,95 +53,75 @@ enum InspSocketError }; /* Required forward declarations */ -class InspSocket; +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 InspTimer +class CoreExport SocketTimeout : public Timer { private: - /** InspSocket the class is attached to + /** BufferedSocket the class is attached to */ - InspSocket* sock; + 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 InspSocket + * @param fd File descriptor of BufferedSocket * @pram Instance server instance to attach to - * @param thesock InspSocket 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, InspSocket* thesock, long secs_from_now, time_t now) : InspTimer(secs_from_now, now), sock(thesock), ServerInstance(Instance), sfd(fd) { }; + 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 - * and bindings. + * that all use is fully asynchronous. + * + * To use BufferedSocket, you must inherit a class from it. */ -class CoreExport InspSocket : public EventHandler +class CoreExport BufferedSocket : public EventHandler { public: - /** - * Bind IP + /** Bind IP */ std::string cbindip; - /** - * Is hooked by a module for low level IO + /** Instance we were created by */ - bool IsIOHooked; - - /** - * Instance we were created by - */ - InspIRCd* Instance; + InspIRCd* ServerInstance; - /** - * Timeout class or NULL + /** Timeout class or NULL */ SocketTimeout* Timeout; - /** - * Timeout length - */ - unsigned long timeout_val; - - /** - * Socket output buffer (binary safe) + /** 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; @@ -159,22 +130,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 @@ -190,6 +146,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(); @@ -199,7 +156,7 @@ class CoreExport InspSocket : public EventHandler * 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 @@ -207,12 +164,6 @@ 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. - */ - bool WaitingForWriteEvent; - /** * Bind to an address * @param ip IP to bind to @@ -220,36 +171,38 @@ class CoreExport InspSocket : public EventHandler */ bool BindAddr(const std::string &ip); + /** (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(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 @@ -264,7 +217,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, @@ -281,21 +234,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(); /** - * When it is ok to write to the socket, and a + * 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 + * 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(). + * 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 */ - virtual bool OnWriteReady(); + bool OnWriteReady(); /** * When an outbound connection fails, and the @@ -314,9 +277,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(); @@ -325,7 +286,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 @@ -339,58 +300,23 @@ 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); - - /** - * 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(); - - /** - * 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. - */ - bool Poll(); + BufferedSocketState GetState(); - /** - * This method returns the socket's file descriptor - * as assigned by the operating system, or -1 - * if no descriptor has been assigned. + /** Mark a socket as being connected and call appropriate events. */ - int GetFd(); + bool InternalMarkConnected(); /** * This method causes the socket to close, and may @@ -404,25 +330,14 @@ 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. - */ - 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. - * - * NOTE: This method is DEPRECIATED and will be - * ignored if called! + * This method is asyncronous. + * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated */ - void MarkAsClosed(); + virtual bool DoConnect(unsigned long maxtime); /** Handle event from EventHandler parent class */ @@ -434,4 +349,3 @@ class CoreExport InspSocket : public EventHandler }; #endif -