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
92 SocketTimeout(int fd, BufferedSocket* thesock, long secs_from_now) : Timer(secs_from_now), sock(thesock), sfd(fd) { }
96 virtual bool Tick(time_t now);
100 * StreamSocket is a class that wraps a TCP socket and handles send
101 * and receive queues, including passing them to IO hooks
103 class CoreExport StreamSocket : public EventHandler
106 /** Socket send queue
111 /** One element of the queue, a continuous buffer
113 typedef std::string Element;
115 /** Sequence container of buffers in the queue
117 typedef std::deque<Element> Container;
119 /** Container iterator
121 typedef Container::const_iterator const_iterator;
123 SendQueue() : nbytes(0) { }
125 /** Return whether the queue is empty
126 * @return True if the queue is empty, false otherwise
128 bool empty() const { return (nbytes == 0); }
130 /** Get the number of individual buffers in the queue
131 * @return Number of individual buffers in the queue
133 Container::size_type size() const { return data.size(); }
135 /** Get the number of queued bytes
136 * @return Size in bytes of the data in the queue
138 size_t bytes() const { return nbytes; }
140 /** Get the first buffer of the queue
141 * @return A reference to the first buffer in the queue
143 const Element& front() const { return data.front(); }
145 /** Get an iterator to the first buffer in the queue.
146 * The returned iterator cannot be used to make modifications to the queue,
147 * for that purpose the member functions push_*(), pop_front(), erase_front() and clear() can be used.
148 * @return Iterator referring to the first buffer in the queue, or end() if there are no elements.
150 const_iterator begin() const { return data.begin(); }
152 /** Get an iterator to the (theoretical) buffer one past the end of the queue.
153 * @return Iterator referring to one element past the end of the container
155 const_iterator end() const { return data.end(); }
157 /** Remove the first buffer in the queue
161 nbytes -= data.front().length();
165 /** Remove bytes from the beginning of the first buffer
166 * @param n Number of bytes to remove
168 void erase_front(Element::size_type n)
171 data.front().erase(0, n);
174 /** Insert a new buffer at the beginning of the queue
175 * @param newdata Data to add
177 void push_front(const Element& newdata)
179 data.push_front(newdata);
180 nbytes += newdata.length();
183 /** Insert a new buffer at the end of the queue
184 * @param newdata Data to add
186 void push_back(const Element& newdata)
188 data.push_back(newdata);
189 nbytes += newdata.length();
200 void moveall(SendQueue& other)
202 nbytes += other.bytes();
203 data.insert(data.end(), other.data.begin(), other.data.end());
208 /** Private send queue. Note that individual strings may be shared.
212 /** Length, in bytes, of the sendq
218 /** The IOHook that handles raw I/O for this socket, or NULL */
221 /** Send queue of the socket
225 /** Error - if nonempty, the socket is dead, and this is the reason. */
228 /** Check if the socket has an error set, if yes, call OnError
229 * @param err Error to pass to OnError()
231 void CheckError(BufferedSocketError err);
233 /** Read data from the socket into the recvq, if successful call OnDataReady()
237 /** Send as much data contained in a SendQueue object as possible.
238 * All data which successfully sent will be removed from the SendQueue.
239 * @param sq SendQueue to flush
241 void FlushSendQ(SendQueue& sq);
243 /** Read incoming data into a receive queue.
244 * @param rq Receive queue to put incoming data into
245 * @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
247 int ReadToRecvQ(std::string& rq);
249 /** Read data from a hook chain recursively, starting at 'hook'.
250 * If 'hook' is NULL, the recvq is filled with data from SocketEngine::Recv(), otherwise it is filled with data from the
251 * next hook in the chain.
252 * @param hook Next IOHook in the chain, can be NULL
253 * @param rq Receive queue to put incoming data into
254 * @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
255 the socket and put into the recvq
257 int HookChainRead(IOHook* hook, std::string& rq);
262 StreamSocket() : iohook(NULL) { }
263 IOHook* GetIOHook() const;
264 void AddIOHook(IOHook* hook);
267 /** Flush the send queue
271 /** Called by the socket engine on a read event
273 void OnEventHandlerRead() CXX11_OVERRIDE;
275 /** Called by the socket engine on a write event
277 void OnEventHandlerWrite() CXX11_OVERRIDE;
279 /** Called by the socket engine on error
280 * @param errcode Error
282 void OnEventHandlerError(int errcode) CXX11_OVERRIDE;
284 /** Sets the error message for this socket. Once set, the socket is dead. */
285 void SetError(const std::string& err) { if (error.empty()) error = err; }
287 /** Gets the error message for this socket. */
288 const std::string& getError() const { return error; }
290 /** Called when new data is present in recvq */
291 virtual void OnDataReady() = 0;
292 /** Called when the socket gets an error from socket engine or IO hook */
293 virtual void OnError(BufferedSocketError e) = 0;
295 /** Send the given data out the socket, either now or when writes unblock
297 void WriteData(const std::string& data);
298 /** Convenience function: read a line from the socket
299 * @param line The line read
300 * @param delim The line delimiter
301 * @return true if a line was read
303 bool GetNextLine(std::string& line, char delim = '\n');
304 /** Useful for implementing sendq exceeded */
305 size_t getSendQSize() const;
307 SendQueue& GetSendQ() { return sendq; }
310 * Close the socket, remove from socket engine, etc
312 virtual void Close();
313 /** This ensures that close is called prior to destructor */
314 virtual CullResult cull() CXX11_OVERRIDE;
316 /** Get the IOHook of a module attached to this socket
317 * @param mod Module whose IOHook to return
318 * @return IOHook belonging to the module or NULL if the module haven't attached an IOHook to this socket
320 IOHook* GetModHook(Module* mod) const;
323 * BufferedSocket is an extendable socket class which modules
324 * can use for TCP socket support. It is fully integrated
325 * into InspIRCds socket loop and attaches its sockets to
326 * the core's instance of the SocketEngine class, meaning
327 * that all use is fully asynchronous.
329 * To use BufferedSocket, you must inherit a class from it.
331 class CoreExport BufferedSocket : public StreamSocket
334 /** Timeout object or NULL
336 SocketTimeout* Timeout;
339 * The state for this socket, either
340 * listening, connecting, connected
343 BufferedSocketState state;
347 * This constructor is used to associate
348 * an existing connecting with an BufferedSocket
349 * class. The given file descriptor must be
350 * valid, and when initialized, the BufferedSocket
351 * will be placed in CONNECTED state.
353 BufferedSocket(int newfd);
355 /** Begin connection to the given address
356 * This will create a socket, register with socket engine, and start the asynchronous
357 * connection process. If an error is detected at this point (such as out of file descriptors),
358 * OnError will be called; otherwise, the state will become CONNECTING.
359 * @param ipaddr Address to connect to
360 * @param aport Port to connect on
361 * @param maxtime Time to wait for connection
362 * @param connectbindip Address to bind to (if NULL, no bind will be done)
364 void DoConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip);
366 /** This method is called when an outbound connection on your socket is
369 virtual void OnConnected();
371 /** When there is data waiting to be read on a socket, the OnDataReady()
374 virtual void OnDataReady() CXX11_OVERRIDE = 0;
377 * When an outbound connection fails, and the attempt times out, you
378 * will receive this event. The method will trigger once maxtime
379 * seconds are reached (as given in the constructor) just before the
380 * socket's descriptor is closed. A failed DNS lookup may cause this
381 * event if the DNS server is not responding, as well as a failed
382 * connect() call, because DNS lookups are nonblocking as implemented by
385 virtual void OnTimeout();
387 virtual ~BufferedSocket();
389 void OnEventHandlerWrite() CXX11_OVERRIDE;
390 BufferedSocketError BeginConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned long timeout);
391 BufferedSocketError BeginConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip);
394 inline IOHook* StreamSocket::GetIOHook() const { return iohook; }
395 inline void StreamSocket::DelIOHook() { iohook = NULL; }