Fix a bunch of weird indentation and spacing issues.

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

diff --git a/include/inspsocket.h b/include/inspsocket.h
index e432f9c16c130600ede422b4e7dbb41fc38cf3cf..45fa46a5b6a4c528a3dd2997dba56759084f0407 100644 (file)
--- a/include/inspsocket.h
+++ b/include/inspsocket.h
@@ -1,11 +1,17 @@
 /*
  * 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-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007-2009 Robin Burchell <robin+git@viroteck.net>
  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
- *   Copyright (C) 2006-2007 Craig Edwards <craigedwards@brainbox.cc>
- *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
+ *   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
@@ -210,7 +216,7 @@ class CoreExport StreamSocket : public EventHandler
                }
 
         private:
-               /** Private send queue. Note that individual strings may be shared.
+               /** Private send queue. Note that individual strings may be shared.
                 */
                Container data;
 
@@ -227,6 +233,12 @@ class CoreExport StreamSocket : public EventHandler
        };
 
  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;
 
@@ -264,16 +276,25 @@ class CoreExport StreamSocket : public EventHandler
         * @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
+        * 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)
-               : iohook(NULL)
+               : closeonempty(false)
+               , closing(false)
+               , iohook(NULL)
                , type(sstype)
        {
        }
@@ -312,8 +333,9 @@ class CoreExport StreamSocket : public EventHandler
        /** 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 void OnSetEndPoint(const irc::sockets::sockaddrs& local, const irc::sockets::sockaddrs& remote) { }
+       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
         */
@@ -333,6 +355,10 @@ class CoreExport StreamSocket : public EventHandler
         * 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;
 
@@ -341,6 +367,11 @@ class CoreExport StreamSocket : public EventHandler
         * @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
@@ -379,12 +410,11 @@ class CoreExport BufferedSocket : public StreamSocket
         * 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 dest Remote endpoint to connect to.
+        * @param bind Local endpoint to connect from.
         * @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 int maxtime, const std::string& connectbindip);
+       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.
@@ -411,7 +441,6 @@ class CoreExport BufferedSocket : public StreamSocket
  protected:
        void OnEventHandlerWrite() CXX11_OVERRIDE;
        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; }