]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspsocket.h
Change ServerInfo::gecos to description
[user/henk/code/inspircd.git] / include / inspsocket.h
index 53eca2e91d4c292c31a396161cae342ae2bc9401..addb761d119037c510eed2021972fc52ba9a513f 100644 (file)
@@ -88,13 +88,17 @@ 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) { }
+       SocketTimeout(int fd, BufferedSocket* thesock, unsigned int secs_from_now)
+               : Timer(secs_from_now)
+               , sock(thesock)
+               , sfd(fd)
+       {
+       }
 
        /** Handle tick event
         */
-       virtual bool Tick(time_t now);
+       bool Tick(time_t now) CXX11_OVERRIDE;
 };
 
 /**
@@ -198,6 +202,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.
                 */
@@ -228,6 +239,28 @@ 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:
@@ -274,7 +307,7 @@ class CoreExport StreamSocket : public EventHandler
         */
        bool GetNextLine(std::string& line, char delim = '\n');
        /** Useful for implementing sendq exceeded */
-       size_t getSendQSize() const { return sendq.size(); }
+       size_t getSendQSize() const;
 
        SendQueue& GetSendQ() { return sendq; }
 
@@ -283,7 +316,13 @@ class CoreExport StreamSocket : public EventHandler
         */
        virtual void Close();
        /** This ensures that close is called prior to destructor */
-       virtual CullResult cull();
+       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
@@ -327,7 +366,7 @@ class CoreExport BufferedSocket : public StreamSocket
         * @param maxtime Time to wait for connection
         * @param connectbindip Address to bind to (if NULL, no bind will be done)
         */
-       void DoConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip);
+       void DoConnect(const std::string& ipaddr, int aport, unsigned int maxtime, const std::string& connectbindip);
 
        /** This method is called when an outbound connection on your socket is
         * completed.
@@ -337,7 +376,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;
+       void OnDataReady() CXX11_OVERRIDE = 0;
 
        /**
         * When an outbound connection fails, and the attempt times out, you
@@ -353,10 +392,9 @@ class CoreExport BufferedSocket : public StreamSocket
        virtual ~BufferedSocket();
  protected:
        void OnEventHandlerWrite() CXX11_OVERRIDE;
-       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);
+       BufferedSocketError BeginConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned int timeout);
+       BufferedSocketError BeginConnect(const std::string& ipaddr, int aport, unsigned int maxtime, const std::string& connectbindip);
 };
 
 inline IOHook* StreamSocket::GetIOHook() const { return iohook; }
-inline void StreamSocket::AddIOHook(IOHook* hook) { iohook = hook; }
 inline void StreamSocket::DelIOHook() { iohook = NULL; }