X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspsocket.h;h=45fa46a5b6a4c528a3dd2997dba56759084f0407;hb=b4a174ee9c32d62ea6bf010e837e8c5b1c3d36a3;hp=53eca2e91d4c292c31a396161cae342ae2bc9401;hpb=0b63ccd0b5cb26883d6becb196fb98e4f95d0397;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspsocket.h b/include/inspsocket.h index 53eca2e91..45fa46a5b 100644 --- a/include/inspsocket.h +++ b/include/inspsocket.h @@ -1,11 +1,17 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2020 Matt Schatz + * Copyright (C) 2019 linuxdaemon + * Copyright (C) 2013, 2015-2016 Attila Molnar + * Copyright (C) 2012-2013, 2017-2019 Sadie Powell + * Copyright (C) 2012 Robby + * Copyright (C) 2009 Uli Schlachter * Copyright (C) 2009 Daniel De Graaf - * Copyright (C) 2007-2008 Robin Burchell + * Copyright (C) 2007-2009 Robin Burchell * Copyright (C) 2007 Dennis Friis - * Copyright (C) 2006-2007 Craig Edwards - * Copyright (C) 2006 Oliver Lupton + * Copyright (C) 2006, 2010 Craig Edwards + * Copyright (C) 2006 Oliver Lupton * * 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 @@ -88,13 +94,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,8 +208,15 @@ 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. + /** Private send queue. Note that individual strings may be shared. */ Container data; @@ -208,7 +225,20 @@ class CoreExport StreamSocket : public EventHandler 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; @@ -228,10 +258,46 @@ 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: + /** 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: - StreamSocket() : iohook(NULL) { } + 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(); @@ -264,6 +330,13 @@ class CoreExport StreamSocket : public EventHandler /** 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); @@ -274,7 +347,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; } @@ -282,8 +355,23 @@ 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 */ - 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; + + /** 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 @@ -322,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 long 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. @@ -337,7 +424,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 +440,8 @@ 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); }; inline IOHook* StreamSocket::GetIOHook() const { return iohook; } -inline void StreamSocket::AddIOHook(IOHook* hook) { iohook = hook; } inline void StreamSocket::DelIOHook() { iohook = NULL; }