2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
7 * Copyright (C) 2006-2007 Craig Edwards <craigedwards@brainbox.cc>
8 * Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 * States which a socket may be in
33 enum BufferedSocketState
35 /** Socket disconnected */
37 /** Socket connecting */
39 /** Socket fully connected */
41 /** Socket has an error */
46 * Error types which a socket may exhibit
48 enum BufferedSocketError
52 /** Socket was closed by peer */
54 /** Socket connect timed out */
56 /** Socket could not be created */
58 /** Socket could not connect (refused) */
60 /** Socket could not bind to local port/ip */
62 /** Socket could not write data */
64 /** No more file descriptors left to create socket! */
66 /** Some other error */
70 /* Required forward declarations */
73 /** Used to time out socket connections
75 class CoreExport SocketTimeout : public Timer
78 /** BufferedSocket the class is attached to
82 /** File descriptor of class this is attached to
87 /** Create a socket timeout class
88 * @param fd File descriptor of BufferedSocket
89 * @param thesock BufferedSocket to attach to
90 * @param secs_from_now Seconds from now to time out
91 * @param now The current time
93 SocketTimeout(int fd, BufferedSocket* thesock, long secs_from_now) : Timer(secs_from_now), sock(thesock), sfd(fd) { }
97 virtual bool Tick(time_t now);
101 * StreamSocket is a class that wraps a TCP socket and handles send
102 * and receive queues, including passing them to IO hooks
104 class CoreExport StreamSocket : public EventHandler
106 /** The IOHook that handles raw I/O for this socket, or NULL */
109 /** Private send queue. Note that individual strings may be shared
111 std::deque<std::string> sendq;
112 /** Length, in bytes, of the sendq */
114 /** Error - if nonempty, the socket is dead, and this is the reason. */
119 StreamSocket() : iohook(NULL), sendq_len(0) {}
120 IOHook* GetIOHook() const;
121 void AddIOHook(IOHook* hook);
123 /** Handle event from socket engine.
124 * This will call OnDataReady if there is *new* data in recvq
126 virtual void HandleEvent(EventType et, int errornum = 0);
127 /** Dispatched from HandleEvent */
128 virtual void DoRead();
129 /** Dispatched from HandleEvent */
130 virtual void DoWrite();
132 /** Sets the error message for this socket. Once set, the socket is dead. */
133 void SetError(const std::string& err) { if (error.empty()) error = err; }
135 /** Gets the error message for this socket. */
136 const std::string& getError() const { return error; }
138 /** Called when new data is present in recvq */
139 virtual void OnDataReady() = 0;
140 /** Called when the socket gets an error from socket engine or IO hook */
141 virtual void OnError(BufferedSocketError e) = 0;
143 /** Send the given data out the socket, either now or when writes unblock
145 void WriteData(const std::string& data);
146 /** Convenience function: read a line from the socket
147 * @param line The line read
148 * @param delim The line delimiter
149 * @return true if a line was read
151 bool GetNextLine(std::string& line, char delim = '\n');
152 /** Useful for implementing sendq exceeded */
153 inline size_t getSendQSize() const { return sendq_len; }
156 * Close the socket, remove from socket engine, etc
158 virtual void Close();
159 /** This ensures that close is called prior to destructor */
160 virtual CullResult cull();
163 * BufferedSocket is an extendable socket class which modules
164 * can use for TCP socket support. It is fully integrated
165 * into InspIRCds socket loop and attaches its sockets to
166 * the core's instance of the SocketEngine class, meaning
167 * that all use is fully asynchronous.
169 * To use BufferedSocket, you must inherit a class from it.
171 class CoreExport BufferedSocket : public StreamSocket
174 /** Timeout object or NULL
176 SocketTimeout* Timeout;
179 * The state for this socket, either
180 * listening, connecting, connected
183 BufferedSocketState state;
187 * This constructor is used to associate
188 * an existing connecting with an BufferedSocket
189 * class. The given file descriptor must be
190 * valid, and when initialized, the BufferedSocket
191 * will be placed in CONNECTED state.
193 BufferedSocket(int newfd);
195 /** Begin connection to the given address
196 * This will create a socket, register with socket engine, and start the asynchronous
197 * connection process. If an error is detected at this point (such as out of file descriptors),
198 * OnError will be called; otherwise, the state will become CONNECTING.
199 * @param ipaddr Address to connect to
200 * @param aport Port to connect on
201 * @param maxtime Time to wait for connection
202 * @param connectbindip Address to bind to (if NULL, no bind will be done)
204 void DoConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip);
206 /** This method is called when an outbound connection on your socket is
209 virtual void OnConnected();
211 /** When there is data waiting to be read on a socket, the OnDataReady()
214 virtual void OnDataReady() = 0;
217 * When an outbound connection fails, and the attempt times out, you
218 * will receive this event. The method will trigger once maxtime
219 * seconds are reached (as given in the constructor) just before the
220 * socket's descriptor is closed. A failed DNS lookup may cause this
221 * event if the DNS server is not responding, as well as a failed
222 * connect() call, because DNS lookups are nonblocking as implemented by
225 virtual void OnTimeout();
227 virtual ~BufferedSocket();
229 virtual void DoWrite();
230 BufferedSocketError BeginConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned long timeout);
231 BufferedSocketError BeginConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip);
234 inline IOHook* StreamSocket::GetIOHook() const { return iohook; }
235 inline void StreamSocket::AddIOHook(IOHook* hook) { iohook = hook; }
236 inline void StreamSocket::DelIOHook() { iohook = NULL; }