X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspsocket.h;h=c62c5a25099375193622b4331963256ef2e819ea;hb=4c751dbbe8945e5efc230a59b0ed51c2ba10cf92;hp=d165d64f2429285a449a20ec1cf68a13fa7daaeb;hpb=f2acdbc3820f0f4f5ef76a0a64e73d2a320df91f;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspsocket.h b/include/inspsocket.h index d165d64f2..c62c5a250 100644 --- a/include/inspsocket.h +++ b/include/inspsocket.h @@ -1,32 +1,35 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2007-2008 Robin Burchell + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006-2007 Craig Edwards + * Copyright (C) 2006 Oliver Lupton * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. * - * --------------------------------------------------- + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ -#ifndef __INSP_SOCKET_H__ -#define __INSP_SOCKET_H__ -#include -#include -#include -#include "dns.h" -#include "inspircd_config.h" -#include "socket.h" -#include "inspsocket.h" +#ifndef INSPSOCKET_H +#define INSPSOCKET_H + #include "timer.h" /** * States which a socket may be in */ -enum InspSocketState +enum BufferedSocketState { /** Socket disconnected */ I_DISCONNECTED, @@ -34,8 +37,6 @@ enum InspSocketState I_CONNECTING, /** Socket fully connected */ I_CONNECTED, - /** Socket listening for connections */ - I_LISTENING, /** Socket has an error */ I_ERROR }; @@ -43,8 +44,12 @@ enum InspSocketState /** * Error types which a socket may exhibit */ -enum InspSocketError +enum BufferedSocketError { + /** No error */ + I_ERR_NONE, + /** Socket was closed by peer */ + I_ERR_DISCONNECT, /** Socket connect timed out */ I_ERR_TIMEOUT, /** Socket could not be created */ @@ -53,385 +58,180 @@ enum InspSocketError 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 + I_ERR_NOMOREFDS, + /** Some other error */ + I_ERR_OTHER }; /* 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; +class BufferedSocket; /** Used to time out socket connections */ -class CoreExport SocketTimeout : public InspTimer +class CoreExport SocketTimeout : public Timer { private: - /** InspSocket the class is attached to - */ - InspSocket* sock; - /** Server instance creating the timeout class + /** BufferedSocket the class is attached to */ - InspIRCd* ServerInstance; + BufferedSocket* sock; + /** 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 fd File descriptor of BufferedSocket + * @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, BufferedSocket* thesock, long secs_from_now, time_t now) : Timer(secs_from_now, now), sock(thesock), sfd(fd) { } + /** Handle tick event */ virtual void Tick(time_t now); }; /** - * 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. + * StreamSocket is a class that wraps a TCP socket and handles send + * and receive queues, including passing them to IO hooks */ -class CoreExport InspSocket : public EventHandler +class CoreExport StreamSocket : public EventHandler { + /** Module that handles raw I/O for this socket, or NULL */ + reference IOHook; + /** Private send queue. Note that individual strings may be shared + */ + std::deque sendq; + /** Length, in bytes, of the sendq */ + size_t sendq_len; + /** Error - if nonempty, the socket is dead, and this is the reason. */ + std::string error; + protected: + std::string recvq; public: - - /** - * Bind IP + StreamSocket() : sendq_len(0) {} + inline Module* GetIOHook(); + inline void AddIOHook(Module* m); + inline void DelIOHook(); + /** Handle event from socket engine. + * This will call OnDataReady if there is *new* data in recvq */ - std::string cbindip; + virtual void HandleEvent(EventType et, int errornum = 0); + /** Dispatched from HandleEvent */ + virtual void DoRead(); + /** Dispatched from HandleEvent */ + virtual void DoWrite(); - /** - * Is hooked by a module for low level IO - */ - bool IsIOHooked; + /** Sets the error message for this socket. Once set, the socket is dead. */ + void SetError(const std::string& err) { if (error.empty()) error = err; } - /** - * Instance we were created by - */ - InspIRCd* Instance; + /** Gets the error message for this socket. */ + const std::string& getError() const { return error; } - /** - * Timeout class or NULL - */ - SocketTimeout* Timeout; + /** Called when new data is present in recvq */ + virtual void OnDataReady() = 0; + /** Called when the socket gets an error from socket engine or IO hook */ + virtual void OnError(BufferedSocketError e) = 0; - /** - * Timeout length + /** Send the given data out the socket, either now or when writes unblock */ - unsigned long timeout_val; - - /** - * Socket output buffer (binary safe) + void WriteData(const std::string& data); + /** Convenience function: read a line from the socket + * @param line The line read + * @param delim The line delimiter + * @return true if a line was read */ - std::deque outbuffer; + bool GetNextLine(std::string& line, char delim = '\n'); + /** Useful for implementing sendq exceeded */ + inline size_t getSendQSize() const { return sendq_len; } /** - * The hostname connected to + * Close the socket, remove from socket engine, etc */ - char host[MAXBUF]; - - /** - * The port connected to, or the port - * this socket is listening on + virtual void Close(); + /** This ensures that close is called prior to destructor */ + virtual CullResult cull(); +}; +/** + * 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 StreamSocket +{ + public: + /** Timeout object or NULL */ - int port; + SocketTimeout* Timeout; /** * The state for this socket, either * 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]; - - /** - * The IP address being connected - * to stored in string form for - * easy retrieval by accessors. - */ - char IP[MAXBUF]; - - /** - * Used by accept() to indicate the - * sizes of the sockaddr_in structures - */ - socklen_t length; - - /** Flushes the write buffer - */ - bool FlushWriteBuffer(); - - /** Set the queue sizes - * This private method sets the operating system queue - * sizes for this socket to 65535 so that it can queue - * more information without application-level queueing - * which was required in older software. - */ - void SetQueues(int nfd); - - /** When the socket has been marked as closing, this flag - * will be set to true, then the next time the socket is - * examined, the socket is deleted and closed. - */ - 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 - * @return True is the binding succeeded - */ - bool BindAddr(const std::string &ip); - - /** - * The default constructor does nothing - * and should not be used. - */ - InspSocket(InspIRCd* SI); + BufferedSocketState state; + BufferedSocket(); /** * 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 - * will be set with the given IP address - * and placed in CONNECTED state. - */ - 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 '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. + * valid, and when initialized, the BufferedSocket + * will be placed in CONNECTED state. */ - InspSocket(InspIRCd* SI, const std::string &ipaddr, int port, bool listening, unsigned long maxtime, const std::string &connectbindip = ""); + BufferedSocket(int newfd); - /** - * This method is called when an outbound - * connection on your socket is completed. - * @return false to abort the connection, true to continue - */ - virtual bool OnConnected(); - - /** - * This method is called when an error occurs. - * A closed socket in itself is not an error, - * however errors also generate close events. - * @param e The error type which occured + /** Begin connection to the given address + * This will create a socket, register with socket engine, and start the asynchronous + * connection process. If an error is detected at this point (such as out of file descriptors), + * OnError will be called; otherwise, the state will become CONNECTING. + * @param ipaddr Address to connect to + * @param aport Port to connect on + * @param maxtime Time to wait for connection + * @param connectbindip Address to bind to (if NULL, no bind will be done) */ - virtual void OnError(InspSocketError e); + void DoConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip); - /** - * When an established connection is terminated, - * the OnDisconnect method is triggered. + /** This method is called when an outbound connection on your socket is + * completed. */ - virtual int OnDisconnect(); + virtual void OnConnected(); - /** - * When there is data waiting to be read on a - * socket, the OnDataReady() method is called. - * Within this method, you *MUST* call the Read() - * method to read any pending data. At its lowest - * level, this event is signalled by the core via - * 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. - * @return false to close the socket + /** When there is data waiting to be read on a socket, the OnDataReady() + * method is called. */ - virtual bool OnDataReady(); + virtual void OnDataReady() = 0; /** - * 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. - * The method will trigger once maxtime seconds are - * reached (as given in the constructor) just - * before the socket's descriptor is closed. - * A failed DNS lookup may cause this event if - * the DNS server is not responding, as well as - * a failed connect() call, because DNS lookups are - * nonblocking as implemented by this class. + * When an outbound connection fails, and the attempt times out, you + * will receive this event. The method will trigger once maxtime + * seconds are reached (as given in the constructor) just before the + * socket's descriptor is closed. A failed DNS lookup may cause this + * event if the DNS server is not responding, as well as a failed + * connect() call, because DNS lookups are nonblocking as implemented by + * this class. */ virtual void OnTimeout(); - /** - * 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. - */ - virtual void OnClose(); - - /** - * Reads all pending bytes from the socket - * into a char* array which can be up to - * 16 kilobytes in length. - */ - virtual char* Read(); - - /** - * Returns the IP address associated with - * this connection, or an empty string if - * no IP address exists. - */ - std::string GetIP(); - - /** - * 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); - - /** - * 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(); - - /** - * 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(); - - /** - * 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 - * and OnError. - */ - virtual void Close(); - - /** - * The destructor may implicitly call OnClose(), and - * will close() and shutdown() the file descriptor - * used for this socket. - */ - virtual ~InspSocket(); - - /** - * 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! - */ - void MarkAsClosed(); - - /** Handle event from EventHandler parent class - */ - void HandleEvent(EventType et, int errornum = 0); - - /** Returns true if this socket is readable - */ - bool Readable(); + virtual ~BufferedSocket(); + protected: + virtual void DoWrite(); + BufferedSocketError BeginConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned long timeout); + BufferedSocketError BeginConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip); }; -#endif +#include "modules.h" +inline Module* StreamSocket::GetIOHook() { return IOHook; } +inline void StreamSocket::AddIOHook(Module* m) { IOHook = m; } +inline void StreamSocket::DelIOHook() { IOHook = NULL; } +#endif