Only subclass Simple{Channel,User}ModeHandler when necessary.

[user/henk/code/inspircd.git] / include / inspsocket.h

diff --git a/include/inspsocket.h b/include/inspsocket.h
index 43bd3e3ab01e55aedf428af1f2b16ecaca8d765d..5c9c1059abe9faca68af318bb2997d8cc2e66032 100644 (file)
--- a/include/inspsocket.h
+++ b/include/inspsocket.h
@@ -88,7 +88,6 @@ class CoreExport SocketTimeout : public Timer
         * @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, BufferedSocket* thesock, long secs_from_now) : Timer(secs_from_now), sock(thesock), sfd(fd) { }
 
@@ -198,6 +197,13 @@ class CoreExport StreamSocket : public EventHandler
                        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.
                 */
@@ -212,11 +218,10 @@ class CoreExport StreamSocket : public EventHandler
        /** The IOHook that handles raw I/O for this socket, or NULL */
        IOHook* iohook;
 
-       /** Private send queue. Note that individual strings may be shared
+       /** Send queue of the socket
         */
-       std::deque<std::string> sendq;
-       /** Length, in bytes, of the sendq */
-       size_t sendq_len;
+       SendQueue sendq;
+
        /** Error - if nonempty, the socket is dead, and this is the reason. */
        std::string error;
 
@@ -229,10 +234,32 @@ class CoreExport StreamSocket : public EventHandler
         */
        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:
        std::string recvq;
  public:
-       StreamSocket() : iohook(NULL), sendq_len(0) {}
+       StreamSocket() : iohook(NULL) { }
        IOHook* GetIOHook() const;
        void AddIOHook(IOHook* hook);
        void DelIOHook();
@@ -275,14 +302,22 @@ class CoreExport StreamSocket : public EventHandler
         */
        bool GetNextLine(std::string& line, char delim = '\n');
        /** Useful for implementing sendq exceeded */
-       inline size_t getSendQSize() const { return sendq_len; }
+       size_t getSendQSize() const;
+
+       SendQueue& GetSendQ() { return sendq; }
 
        /**
         * Close the socket, remove from socket engine, etc
         */
        virtual void Close();
        /** This ensures that close is called prior to destructor */
-       virtual CullResult cull();
+       virtual 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;
 };
 /**
  * BufferedSocket is an extendable socket class which modules
@@ -336,7 +371,7 @@ class CoreExport BufferedSocket : public StreamSocket
        /** When there is data waiting to be read on a socket, the OnDataReady()
         * method is called.
         */
-       virtual void OnDataReady() = 0;
+       virtual void OnDataReady() CXX11_OVERRIDE = 0;
 
        /**
         * When an outbound connection fails, and the attempt times out, you
@@ -357,5 +392,4 @@ class CoreExport BufferedSocket : public StreamSocket
 };
 
 inline IOHook* StreamSocket::GetIOHook() const { return iohook; }
-inline void StreamSocket::AddIOHook(IOHook* hook) { iohook = hook; }
 inline void StreamSocket::DelIOHook() { iohook = NULL; }