]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspsocket.h
Fix a bunch of weird indentation and spacing issues.
[user/henk/code/inspircd.git] / include / inspsocket.h
index 98fbc018f95a445cc4eae2e7ce31581c44dca948..45fa46a5b6a4c528a3dd2997dba56759084f0407 100644 (file)
@@ -1 +1,447 @@
-/*       +------------------------------------+\r *       | Inspire Internet Relay Chat Daemon |\r *       +------------------------------------+\r *\r *  InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r *        the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#ifndef __INSP_SOCKET_H__\r#define __INSP_SOCKET_H__\r\r#include <sstream>\r#include <string>\r#include <deque>\r#include "dns.h"\r#include "inspircd_config.h"\r#include "socket.h"\r#include "inspsocket.h"\r#include "timer.h"\r\r/**\r * States which a socket may be in\r */\renum InspSocketState\r{\r    /** Socket disconnected */\r     I_DISCONNECTED,\r        /** Socket connecting */\r       I_CONNECTING,\r  /** Socket fully connected */\r  I_CONNECTED,\r   /** Socket listening for connections */\r        I_LISTENING,\r   /** Socket has an error */\r     I_ERROR\r};\r\r/**\r * Error types which a socket may exhibit\r */\renum InspSocketError\r{\r   /** Socket connect timed out */\r        I_ERR_TIMEOUT,\r /** Socket could not be created */\r     I_ERR_SOCKET,\r  /** Socket could not connect (refused) */\r      I_ERR_CONNECT,\r /** Socket could not bind to local port/ip */\r  I_ERR_BIND,\r    /** Socket could not reslve host (depreciated) */\r      I_ERR_RESOLVE,\r /** Socket could not write data */\r     I_ERR_WRITE,\r   /** No more file descriptors left to create socket! */\r I_ERR_NOMOREFDS\r};\r\r/* Required forward declarations */\rclass InspSocket;\rclass InspIRCd;\r\rusing irc::sockets::insp_sockaddr;\rusing irc::sockets::insp_inaddr;\rusing irc::sockets::insp_ntoa;\rusing irc::sockets::insp_aton;\r\r/** Used to time out socket connections\r */\rclass CoreExport SocketTimeout : public InspTimer\r{\r private:\r        /** InspSocket the class is attached to\r         */\r    InspSocket* sock;\r      /** Server instance creating the timeout class\r  */\r    InspIRCd* ServerInstance;\r      /** File descriptor of class this is attached to\r        */\r    int sfd;\r public:\r      /** Create a socket timeout class\r       * @param fd File descriptor of InspSocket\r      * @pram Instance server instance to attach to\r  * @param thesock InspSocket to attach to\r       * @param secs_from_now Seconds from now to time out\r    * @param now The current time\r  */\r    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) { };\r  /** Handle tick event\r   */\r    virtual void Tick(time_t now);\r};\r\r/**\r * InspSocket is an extendable socket class which modules\r * can use for TCP socket support. It is fully integrated\r * into InspIRCds socket loop and attaches its sockets to\r * the core's instance of the SocketEngine class, meaning\r * that any sockets you create have the same power and\r * abilities as a socket created by the core itself.\r * To use InspSocket, you must inherit a class from it,\r * and use the InspSocket constructors to establish connections\r * and bindings.\r */\rclass CoreExport InspSocket : public EventHandler\r{\r public:\r\r  /** \r    * Bind IP\r      */\r    std::string cbindip;\r\r  /** \r    * Is hooked by a module for low level IO\r       */\r    bool IsIOHooked;\r\r      /** \r    * Instance we were created by\r  */\r    InspIRCd* Instance;\r\r   /** \r    * Timeout class or NULL\r        */\r    SocketTimeout* Timeout;\r\r       /** \r    * Timeout length\r       */\r    unsigned long timeout_val;\r\r    /** \r    * Socket output buffer (binary safe)\r   */\r    std::deque<std::string> outbuffer;\r\r    /**\r     * The hostname connected to\r    */\r    char host[MAXBUF];\r\r    /**\r     * The port connected to, or the port\r   * this socket is listening on\r  */\r    int port;\r\r     /**\r     * The state for this socket, either\r    * listening, connecting, connected\r     * or error.\r    */\r    InspSocketState state;\r\r        /**\r     * This value is true if the\r    * socket has timed out.\r        */\r    bool timeout;\r  \r       /**\r     * Socket input buffer, used by read(). The class which\r         * extends InspSocket is expected to implement an extendable\r    * buffer which can grow much larger than 64k,\r  * this buffer is just designed to be temporary storage.\r        * space.\r       */\r    char ibuf[65535];\r\r     /**\r     * The IP address being connected\r       * to stored in string form for\r         * easy retrieval by accessors.\r         */\r    char IP[MAXBUF];\r\r      /**\r     * Used by accept() to indicate the\r     * sizes of the sockaddr_in structures\r  */\r    socklen_t length;\r\r     /** Flushes the write buffer\r    */\r    bool FlushWriteBuffer();\r\r      /** Set the queue sizes\r         * This private method sets the operating system queue\r  * sizes for this socket to 65535 so that it can queue\r  * more information without application-level queueing\r  * which was required in older software.\r        */\r    void SetQueues(int nfd);\r\r      /** When the socket has been marked as closing, this flag\r       * will be set to true, then the next time the socket is\r        * examined, the socket is deleted and closed.\r  */\r    bool ClosePending;\r\r    /** Set to true when we're waiting for a write event.\r   * If this is true and a write event comes in, we\r       * call the write instead of the read method.\r   */\r    bool WaitingForWriteEvent;\r\r    /**\r     * Bind to an address\r   * @param ip IP to bind to\r      * @return True is the binding succeeded\r        */\r    bool BindAddr(const std::string &ip);\r\r /**\r     * The default constructor does nothing\r         * and should not be used.\r      */\r    InspSocket(InspIRCd* SI);\r\r     /**\r     * This constructor is used to associate\r        * an existing connecting with an InspSocket\r    * class. The given file descriptor must be\r     * valid, and when initialized, the InspSocket\r  * will be set with the given IP address\r        * and placed in CONNECTED state.\r       */\r    InspSocket(InspIRCd* SI, int newfd, const char* ip);\r\r  /**\r     * This constructor is used to create a new\r     * socket, either listening for connections, or an outbound connection to another host.\r         * Note that if you specify a hostname in the 'ipaddr' parameter, this class will not\r   * connect. You must resolve your hostnames before passing them to InspSocket. To do so,\r        * you should use the nonblocking class 'Resolver'.\r     * @param ipaddr The IP to connect to, or bind to\r       * @param port The port number to connect to, or bind to\r        * @param listening true to listen on the given host:port pair, or false to connect to them\r     * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated\r       * @param connectbindip When creating an outbound connection, the IP to bind the connection to. If not defined, the port is not bound.\r  * @return On exit, GetState() returns I_ERROR if an error occured, and errno can be used to read the socket error.\r     */\r    InspSocket(InspIRCd* SI, const std::string &ipaddr, int port, bool listening, unsigned long maxtime, const std::string &connectbindip = "");\r\r  /**\r     * This method is called when an outbound\r       * connection on your socket is completed.\r      * @return false to abort the connection, true to continue\r      */\r    virtual bool OnConnected();\r\r   /**\r     * This method is called when an error occurs.\r  * A closed socket in itself is not an error,\r   * however errors also generate close events.\r   * @param e The error type which occured\r        */\r    virtual void OnError(InspSocketError e);\r\r      /**\r     * When an established connection is terminated,\r        * the OnDisconnect method is triggered.\r        */\r    virtual int OnDisconnect();\r\r   /**\r     * When there is data waiting to be read on a\r   * socket, the OnDataReady() method is called.\r  * Within this method, you *MUST* call the Read()\r       * method to read any pending data. At its lowest\r       * level, this event is signalled by the core via\r       * the socket engine. If you return false from this\r     * function, the core removes your socket from its\r      * list and erases it from the socket engine, then\r      * calls InspSocket::Close() and deletes it.\r    * @return false to close the socket\r    */\r    virtual bool OnDataReady();\r\r   /**\r     * When it is ok to write to the socket, and a \r         * write event was requested, this method is\r    * triggered. Within this method you should call\r        * write() or send() etc, to send data to the\r   * other end of the socket. Further write events\r        * will not be triggered unless you call WantWrite().\r   * @return false to close the socket\r    */\r    virtual bool OnWriteReady();\r\r  /**\r     * When an outbound connection fails, and the\r   * attempt times out, you will receive this event.\r      * The method will trigger once maxtime seconds are\r     * reached (as given in the constructor) just\r   * before the socket's descriptor is closed.\r    * A failed DNS lookup may cause this event if\r  * the DNS server is not responding, as well as\r         * a failed connect() call, because DNS lookups are\r     * nonblocking as implemented by this class.\r    */\r    virtual void OnTimeout();\r\r     /**\r     * Whenever close() is called, OnClose() will be\r        * called first. Please note that this means\r    * OnClose will be called alongside OnError(),\r  * OnTimeout(), and Close(), and also when\r      * cancelling a listening socket by calling\r     * the destructor indirectly.\r   */\r    virtual void OnClose();\r\r       /**\r     * Reads all pending bytes from the socket\r      * into a char* array which can be up to\r        * 16 kilobytes in length.\r      */\r    virtual char* Read();\r\r /**\r     * Returns the IP address associated with\r       * this connection, or an empty string if\r       * no IP address exists.\r        */\r    std::string GetIP();\r\r  /**\r     * Writes a std::string to the socket. No carriage\r      * returns or linefeeds are appended to the string.\r     * @param data The data to send\r         */\r    virtual int Write(const std::string &data);\r\r   /**\r     * If your socket is a listening socket, when a new\r     * connection comes in on the socket this method will\r   * be called. Given the new file descriptor in the\r      * parameters, and the IP, it is recommended you copy\r   * them to a new instance of your socket class,\r         * e.g.:\r        *\r      * MySocket* newsocket = new MySocket(newfd,ip);\r        *\r      * Once you have done this, you can then associate the\r  * new socket with the core using Server::AddSocket().\r  */\r    virtual int OnIncomingConnection(int newfd, char* ip);\r\r        /**\r     * Changes the socket's state. The core uses this\r       * to change socket states, and you should not call\r     * it directly.\r         */\r    void SetState(InspSocketState s);\r\r     /**\r     * Call this to receive the next write event\r    * that comes along for this fd to the OnWriteReady\r     * method.\r      */\r    void WantWrite();\r\r     /**\r     * Returns the current socket state.\r    */\r    InspSocketState GetState();\r\r   /**\r     * Only the core should call this function.\r     * When called, it is assumed the socket is ready\r       * to read data, and the method call routes the\r         * event to the various methods of InspSocket\r   * for you to handle. This can also cause the\r   * socket's state to change.\r    */\r    bool Poll();\r\r  /**\r     * This method returns the socket's file descriptor\r     * as assigned by the operating system, or -1\r   * if no descriptor has been assigned.\r  */\r    int GetFd();\r\r  /**\r     * This method causes the socket to close, and may\r      * also be triggered by other methods such as OnTimeout\r         * and OnError.\r         */\r    virtual void Close();\r\r /**\r     * The destructor may implicitly call OnClose(), and\r    * will close() and shutdown() the file descriptor\r      * used for this socket.\r        */\r    virtual ~InspSocket();\r\r        /**\r     * This method attempts to connect to a hostname.\r       * This only occurs on a non-listening socket. This\r     * method is asyncronous.\r       */\r    virtual bool DoConnect();\r\r     /**\r     * This method marks the socket closed.\r         * The next time the core examines a socket marked\r      * as closed, the socket will be closed and the \r        * memory reclaimed.\r    *\r      * NOTE: This method is DEPRECIATED and will be\r         * ignored if called!\r   */\r    void MarkAsClosed();\r\r  /** Handle event from EventHandler parent class\r         */\r    void HandleEvent(EventType et, int errornum = 0);\r\r     /** Returns true if this socket is readable\r     */\r    bool Readable();\r};\r\r#endif\r\r
\ No newline at end of file
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
+ *   Copyright (C) 2013, 2015-2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012-2013, 2017-2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007-2009 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006, 2010 Craig Edwards <brain@inspircd.org>
+ *   Copyright (C) 2006 Oliver Lupton <om@inspircd.org>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+
+#pragma once
+
+#include "timer.h"
+
+class IOHook;
+
+/**
+ * States which a socket may be in
+ */
+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 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 */
+       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 write data */
+       I_ERR_WRITE,
+       /** No more file descriptors left to create socket! */
+       I_ERR_NOMOREFDS,
+       /** Some other error */
+       I_ERR_OTHER
+};
+
+/* Required forward declarations */
+class BufferedSocket;
+
+/** Used to time out socket connections
+ */
+class CoreExport SocketTimeout : public Timer
+{
+ private:
+       /** BufferedSocket the class is attached to
+        */
+       BufferedSocket* sock;
+
+       /** File descriptor of class this is attached to
+        */
+       int sfd;
+
+ public:
+       /** Create a socket timeout class
+        * @param fd File descriptor of BufferedSocket
+        * @param thesock BufferedSocket to attach to
+        * @param secs_from_now Seconds from now to time out
+        */
+       SocketTimeout(int fd, BufferedSocket* thesock, unsigned int secs_from_now)
+               : Timer(secs_from_now)
+               , sock(thesock)
+               , sfd(fd)
+       {
+       }
+
+       /** Handle tick event
+        */
+       bool Tick(time_t now) CXX11_OVERRIDE;
+};
+
+/**
+ * StreamSocket is a class that wraps a TCP socket and handles send
+ * and receive queues, including passing them to IO hooks
+ */
+class CoreExport StreamSocket : public EventHandler
+{
+ public:
+       /** Socket send queue
+        */
+       class SendQueue
+       {
+        public:
+               /** One element of the queue, a continuous buffer
+                */
+               typedef std::string Element;
+
+               /** Sequence container of buffers in the queue
+                */
+               typedef std::deque<Element> Container;
+
+               /** Container iterator
+                */
+               typedef Container::const_iterator const_iterator;
+
+               SendQueue() : nbytes(0) { }
+
+               /** Return whether the queue is empty
+                * @return True if the queue is empty, false otherwise
+                */
+               bool empty() const { return (nbytes == 0); }
+
+               /** Get the number of individual buffers in the queue
+                * @return Number of individual buffers in the queue
+                */
+               Container::size_type size() const { return data.size(); }
+
+               /** Get the number of queued bytes
+                * @return Size in bytes of the data in the queue
+                */
+               size_t bytes() const { return nbytes; }
+
+               /** Get the first buffer of the queue
+                * @return A reference to the first buffer in the queue
+                */
+               const Element& front() const { return data.front(); }
+
+               /** Get an iterator to the first buffer in the queue.
+                * The returned iterator cannot be used to make modifications to the queue,
+                * for that purpose the member functions push_*(), pop_front(), erase_front() and clear() can be used.
+                * @return Iterator referring to the first buffer in the queue, or end() if there are no elements.
+                */
+               const_iterator begin() const { return data.begin(); }
+
+               /** Get an iterator to the (theoretical) buffer one past the end of the queue.
+                * @return Iterator referring to one element past the end of the container
+                */
+               const_iterator end() const { return data.end(); }
+
+               /** Remove the first buffer in the queue
+                */
+               void pop_front()
+               {
+                       nbytes -= data.front().length();
+                       data.pop_front();
+               }
+
+               /** Remove bytes from the beginning of the first buffer
+                * @param n Number of bytes to remove
+                */
+               void erase_front(Element::size_type n)
+               {
+                       nbytes -= n;
+                       data.front().erase(0, n);
+               }
+
+               /** Insert a new buffer at the beginning of the queue
+                * @param newdata Data to add
+                */
+               void push_front(const Element& newdata)
+               {
+                       data.push_front(newdata);
+                       nbytes += newdata.length();
+               }
+
+               /** Insert a new buffer at the end of the queue
+                * @param newdata Data to add
+                */
+               void push_back(const Element& newdata)
+               {
+                       data.push_back(newdata);
+                       nbytes += newdata.length();
+               }
+
+               /** Clear the queue
+                */
+               void clear()
+               {
+                       data.clear();
+                       nbytes = 0;
+               }
+
+               void moveall(SendQueue& other)
+               {
+                       nbytes += other.bytes();
+                       data.insert(data.end(), other.data.begin(), other.data.end());
+                       other.clear();
+               }
+
+        private:
+               /** Private send queue. Note that individual strings may be shared.
+                */
+               Container data;
+
+               /** Length, in bytes, of the sendq
+                */
+               size_t nbytes;
+       };
+
+       /** The type of socket this IOHook represents. */
+       enum Type
+       {
+               SS_UNKNOWN,
+               SS_USER
+       };
+
+ private:
+       /** Whether this socket should close once its sendq is empty */
+       bool closeonempty;
+
+       /** Whether the socket is currently closing or not, used to avoid repeatedly closing a closed socket */
+       bool closing;
+
+       /** The IOHook that handles raw I/O for this socket, or NULL */
+       IOHook* iohook;
+
+       /** Send queue of the socket
+        */
+       SendQueue sendq;
+
+       /** Error - if nonempty, the socket is dead, and this is the reason. */
+       std::string error;
+
+       /** Check if the socket has an error set, if yes, call OnError
+        * @param err Error to pass to OnError()
+        */
+       void CheckError(BufferedSocketError err);
+
+       /** Read data from the socket into the recvq, if successful call OnDataReady()
+        */
+       void DoRead();
+
+       /** Send as much data contained in a SendQueue object as possible.
+        * All data which successfully sent will be removed from the SendQueue.
+        * @param sq SendQueue to flush
+        */
+       void FlushSendQ(SendQueue& sq);
+
+       /** Read incoming data into a receive queue.
+        * @param rq Receive queue to put incoming data into
+        * @return < 0 on error or close, 0 if no new data is ready (but the socket is still connected), > 0 if data was read from the socket and put into the recvq
+        */
+       int ReadToRecvQ(std::string& rq);
+
+       /** Read data from a hook chain recursively, starting at 'hook'.
+        * If 'hook' is NULL, the recvq is filled with data from SocketEngine::Recv(), otherwise it is filled with data from the
+        * next hook in the chain.
+        * @param hook Next IOHook in the chain, can be NULL
+        * @param rq Receive queue to put incoming data into
+        * @return < 0 on error or close, 0 if no new data is ready (but the socket is still connected), > 0 if data was read from
+        * the socket and put into the recvq
+        */
+       int HookChainRead(IOHook* hook, std::string& rq);
+
+ protected:
+       /** The data which has been received from the socket. */
+       std::string recvq;
+
+       /** Swaps the internals of this StreamSocket with another one.
+        * @param other A StreamSocket to swap internals with.
+        */
+       void SwapInternals(StreamSocket& other);
+
+ public:
+       const Type type;
+       StreamSocket(Type sstype = SS_UNKNOWN)
+               : closeonempty(false)
+               , closing(false)
+               , iohook(NULL)
+               , type(sstype)
+       {
+       }
+       IOHook* GetIOHook() const;
+       void AddIOHook(IOHook* hook);
+       void DelIOHook();
+
+       /** Flush the send queue
+        */
+       void DoWrite();
+
+       /** Called by the socket engine on a read event
+        */
+       void OnEventHandlerRead() CXX11_OVERRIDE;
+
+       /** Called by the socket engine on a write event
+        */
+       void OnEventHandlerWrite() CXX11_OVERRIDE;
+
+       /** Called by the socket engine on error
+        * @param errcode Error
+        */
+       void OnEventHandlerError(int errcode) CXX11_OVERRIDE;
+
+       /** Sets the error message for this socket. Once set, the socket is dead. */
+       void SetError(const std::string& err) { if (error.empty()) error = err; }
+
+       /** Gets the error message for this socket. */
+       const std::string& getError() const { return error; }
+
+       /** 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;
+
+       /** Called when the endpoint addresses are changed.
+        * @param local The new local endpoint.
+        * @param remote The new remote endpoint.
+        * @return true if the connection is still open, false if it has been closed
+        */
+       virtual bool OnSetEndPoint(const irc::sockets::sockaddrs& local, const irc::sockets::sockaddrs& remote);
+
+       /** Send the given data out the socket, either now or when writes unblock
+        */
+       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
+        */
+       bool GetNextLine(std::string& line, char delim = '\n');
+       /** Useful for implementing sendq exceeded */
+       size_t getSendQSize() const;
+
+       SendQueue& GetSendQ() { return sendq; }
+
+       /**
+        * Close the socket, remove from socket engine, etc
+        */
+       virtual void Close();
+
+       /** If writeblock is true then only close the socket if all data has been sent. Otherwise, close immediately. */
+       void Close(bool writeblock);
+
+       /** This ensures that close is called prior to destructor */
+       CullResult cull() CXX11_OVERRIDE;
+
+       /** Get the IOHook of a module attached to this socket
+        * @param mod Module whose IOHook to return
+        * @return IOHook belonging to the module or NULL if the module haven't attached an IOHook to this socket
+        */
+       IOHook* GetModHook(Module* mod) const;
+
+       /** Get the last IOHook attached to this socket
+        * @return The last IOHook attached to this socket or NULL if no IOHooks are attached
+        */
+       IOHook* GetLastHook() const;
+};
+/**
+ * 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
+        */
+       SocketTimeout* Timeout;
+
+       /**
+        * The state for this socket, either
+        * listening, connecting, connected
+        * or error.
+        */
+       BufferedSocketState state;
+
+       BufferedSocket();
+       /**
+        * This constructor is used to associate
+        * an existing connecting with an BufferedSocket
+        * class. The given file descriptor must be
+        * valid, and when initialized, the BufferedSocket
+        * will be placed in CONNECTED state.
+        */
+       BufferedSocket(int newfd);
+
+       /** 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 dest Remote endpoint to connect to.
+        * @param bind Local endpoint to connect from.
+        * @param maxtime Time to wait for connection
+        */
+       void DoConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned int maxtime);
+
+       /** This method is called when an outbound connection on your socket is
+        * completed.
+        */
+       virtual void OnConnected();
+
+       /** When there is data waiting to be read on a socket, the OnDataReady()
+        * method is called.
+        */
+       void OnDataReady() CXX11_OVERRIDE = 0;
+
+       /**
+        * 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();
+
+       virtual ~BufferedSocket();
+ protected:
+       void OnEventHandlerWrite() CXX11_OVERRIDE;
+       BufferedSocketError BeginConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned int timeout);
+};
+
+inline IOHook* StreamSocket::GetIOHook() const { return iohook; }
+inline void StreamSocket::DelIOHook() { iohook = NULL; }