1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
17 #ifndef __INSP_SOCKET_H__
18 #define __INSP_SOCKET_H__
24 #include "inspircd_config.h"
28 * States which a socket may be in
30 enum InspSocketState { I_DISCONNECTED, I_RESOLVING, I_CONNECTING, I_CONNECTED, I_LISTENING, I_ERROR };
33 * Error types which a socket may exhibit
35 enum InspSocketError { I_ERR_TIMEOUT, I_ERR_SOCKET, I_ERR_CONNECT, I_ERR_BIND, I_ERR_RESOLVE, I_ERR_WRITE };
38 * InspSocket is an extendable socket class which modules
39 * can use for TCP socket support. It is fully integrated
40 * into InspIRCds socket loop and attaches its sockets to
41 * the core's instance of the SocketEngine class, meaning
42 * that any sockets you create have the same power and
43 * abilities as a socket created by the core itself.
44 * To use InspSocket, you must inherit a class from it,
45 * and use the InspSocket constructors to establish connections
48 class InspSocket : public Extensible
52 std::deque<std::string> outbuffer;
55 * The file descriptor of this socket
60 * The resolver for this socket
64 * The hostname connected to
69 * The port connected to, or the port
70 * this socket is listening on
75 * The state for this socket, either
76 * listening, connecting, connected
79 InspSocketState state;
82 * The host being connected to,
88 * The host being connected to,
94 * When this time is reached,
95 * the socket times out if it is
96 * in the CONNECTING state
101 * This value is true if the
102 * socket has timed out.
107 * Socket input buffer, used by read(). The class which
108 * extends InspSocket is expected to implement an extendable
109 * buffer which can grow much larger than 64k,
110 * this buffer is just designed to be temporary storage.
116 * The IP address being connected
117 * to stored in string form for
118 * easy retrieval by accessors.
123 * Client sockaddr structure used
126 insp_sockaddr client;
129 * Server sockaddr structure used
132 insp_sockaddr server;
135 * Used by accept() to indicate the
136 * sizes of the sockaddr_in structures
140 /** Flushes the write buffer
142 bool FlushWriteBuffer();
144 /** Set the queue sizes
145 * This private method sets the operating system queue
146 * sizes for this socket to 65535 so that it can queue
147 * more information without application-level queueing
148 * which was required in older software.
150 void SetQueues(int nfd);
152 /** When the socket has been marked as closing, this flag
153 * will be set to true, then the next time the socket is
154 * examined, the socket is deleted and closed.
158 /** Set to true when we're waiting for a write event.
159 * If this is true and a write event comes in, we
160 * call the write instead of the read method.
162 bool WaitingForWriteEvent;
169 * The default constructor does nothing
170 * and should not be used.
175 * This constructor is used to associate
176 * an existing connecting with an InspSocket
177 * class. The given file descriptor must be
178 * valid, and when initialized, the InspSocket
179 * will be set with the given IP address
180 * and placed in CONNECTED state.
182 InspSocket(int newfd, const char* ip);
185 * This constructor is used to create a new
186 * socket, either listening for connections, or an outbound connection to another host.
187 * Note that if you specify a hostname in the 'host' parameter, then there will be an extra
188 * step involved (a nonblocking DNS lookup) which will cause your connection to be established
189 * slower than if it was an IP. Therefore, use an IP address where it is available instead.
190 * @param host The hostname to connect to, or bind to
191 * @param port The port number to connect to, or bind to
192 * @param listening true to listen on the given host:port pair, or false to connect to them
193 * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
195 InspSocket(const std::string &host, int port, bool listening, unsigned long maxtime);
198 * This method is called when an outbound
199 * connection on your socket is completed.
200 * @return false to abort the connection, true to continue
202 virtual bool OnConnected();
205 * This method is called when an error occurs.
206 * A closed socket in itself is not an error,
207 * however errors also generate close events.
208 * @param e The error type which occured
210 virtual void OnError(InspSocketError e);
213 * When an established connection is terminated,
214 * the OnDisconnect method is triggered.
216 virtual int OnDisconnect();
219 * When there is data waiting to be read on a
220 * socket, the OnDataReady() method is called.
221 * Within this method, you *MUST* call the Read()
222 * method to read any pending data. At its lowest
223 * level, this event is signalled by the core via
224 * the socket engine. If you return false from this
225 * function, the core removes your socket from its
226 * list and erases it from the socket engine, then
227 * calls InspSocket::Close() and deletes it.
228 * @return false to close the socket
230 virtual bool OnDataReady();
232 virtual bool OnWriteReady();
235 * When an outbound connection fails, and the
236 * attempt times out, you will receive this event.
237 * The method will trigger once maxtime seconds are
238 * reached (as given in the constructor) just
239 * before the socket's descriptor is closed.
240 * A failed DNS lookup may cause this event if
241 * the DNS server is not responding, as well as
242 * a failed connect() call, because DNS lookups are
243 * nonblocking as implemented by this class.
245 virtual void OnTimeout();
248 * Whenever close() is called, OnClose() will be
249 * called first. Please note that this means
250 * OnClose will be called alongside OnError(),
251 * OnTimeout(), and Close(), and also when
252 * cancelling a listening socket by calling
253 * the destructor indirectly.
255 virtual void OnClose();
258 * Reads all pending bytes from the socket
259 * into a char* array which can be up to
260 * 16 kilobytes in length.
262 virtual char* Read();
265 * Returns the IP address associated with
266 * this connection, or an empty string if
267 * no IP address exists.
272 * This function checks if the socket has
273 * timed out yet, given the current time
275 * @return true if timed out, false if not timed out
277 bool Timeout(time_t current);
280 * Writes a std::string to the socket. No carriage
281 * returns or linefeeds are appended to the string.
282 * @param data The data to send
284 virtual int Write(const std::string &data);
287 * If your socket is a listening socket, when a new
288 * connection comes in on the socket this method will
289 * be called. Given the new file descriptor in the
290 * parameters, and the IP, it is recommended you copy
291 * them to a new instance of your socket class,
294 * MySocket* newsocket = new MySocket(newfd,ip);
296 * Once you have done this, you can then associate the
297 * new socket with the core using Server::AddSocket().
299 virtual int OnIncomingConnection(int newfd, char* ip);
302 * Changes the socket's state. The core uses this
303 * to change socket states, and you should not call
306 void SetState(InspSocketState s);
309 * Call this to receive the next write event
310 * that comes along for this fd to the OnWriteReady
316 * Returns the current socket state.
318 InspSocketState GetState();
321 * Only the core should call this function.
322 * When called, it is assumed the socket is ready
323 * to read data, and the method call routes the
324 * event to the various methods of InspSocket
325 * for you to handle. This can also cause the
326 * socket's state to change.
331 * This method returns the socket's file descriptor
332 * as assigned by the operating system, or -1
333 * if no descriptor has been assigned.
338 * This method causes the socket to close, and may
339 * also be triggered by other methods such as OnTimeout
342 virtual void Close();
345 * The destructor may implicitly call OnClose(), and
346 * will close() and shutdown() the file descriptor
347 * used for this socket.
349 virtual ~InspSocket();
352 * This method attempts to resolve the hostname,
353 * if a hostname is given and not an IP,
354 * before a connection can occur. This method is
357 virtual bool DoResolve();
360 * This method attempts to connect to a hostname.
361 * This only occurs on a non-listening socket. This
362 * method is asyncronous.
364 virtual bool DoConnect();
367 * This method marks the socket closed.
368 * The next time the core examines a socket marked
369 * as closed, the socket will be closed and the