1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __INSP_SOCKET_H__
15 #define __INSP_SOCKET_H__
21 #include "inspircd_config.h"
23 #include "inspsocket.h"
27 * States which a socket may be in
29 enum InspSocketState { I_DISCONNECTED, I_CONNECTING, I_CONNECTED, I_LISTENING, I_ERROR };
32 * Error types which a socket may exhibit
34 enum InspSocketError { I_ERR_TIMEOUT, I_ERR_SOCKET, I_ERR_CONNECT, I_ERR_BIND, I_ERR_RESOLVE, I_ERR_WRITE, I_ERR_NOMOREFDS };
39 using irc::sockets::insp_sockaddr;
40 using irc::sockets::insp_inaddr;
41 using irc::sockets::insp_ntoa;
42 using irc::sockets::insp_aton;
44 /** Used to time out socket connections
46 class SocketTimeout : public InspTimer
50 InspIRCd* ServerInstance;
53 SocketTimeout(int fd, InspIRCd* Instance, InspSocket* thesock, long secs_from_now, time_t now) : InspTimer(secs_from_now, now), sock(thesock), ServerInstance(Instance), sfd(fd) { };
54 virtual void Tick(time_t now);
58 * InspSocket is an extendable socket class which modules
59 * can use for TCP socket support. It is fully integrated
60 * into InspIRCds socket loop and attaches its sockets to
61 * the core's instance of the SocketEngine class, meaning
62 * that any sockets you create have the same power and
63 * abilities as a socket created by the core itself.
64 * To use InspSocket, you must inherit a class from it,
65 * and use the InspSocket constructors to establish connections
68 class InspSocket : public EventHandler
76 SocketTimeout* Timeout;
78 unsigned long timeout_val;
80 std::deque<std::string> outbuffer;
83 * The hostname connected to
88 * The port connected to, or the port
89 * this socket is listening on
94 * The state for this socket, either
95 * listening, connecting, connected
98 InspSocketState state;
101 * The host being connected to,
107 * The host being connected to,
113 * This value is true if the
114 * socket has timed out.
119 * Socket input buffer, used by read(). The class which
120 * extends InspSocket is expected to implement an extendable
121 * buffer which can grow much larger than 64k,
122 * this buffer is just designed to be temporary storage.
128 * The IP address being connected
129 * to stored in string form for
130 * easy retrieval by accessors.
135 * Client sockaddr structure used
138 insp_sockaddr client;
141 * Server sockaddr structure used
144 insp_sockaddr server;
147 * Used by accept() to indicate the
148 * sizes of the sockaddr_in structures
152 /** Flushes the write buffer
154 bool FlushWriteBuffer();
156 /** Set the queue sizes
157 * This private method sets the operating system queue
158 * sizes for this socket to 65535 so that it can queue
159 * more information without application-level queueing
160 * which was required in older software.
162 void SetQueues(int nfd);
164 /** When the socket has been marked as closing, this flag
165 * will be set to true, then the next time the socket is
166 * examined, the socket is deleted and closed.
170 /** Set to true when we're waiting for a write event.
171 * If this is true and a write event comes in, we
172 * call the write instead of the read method.
174 bool WaitingForWriteEvent;
179 * The default constructor does nothing
180 * and should not be used.
182 InspSocket(InspIRCd* SI);
185 * This constructor is used to associate
186 * an existing connecting with an InspSocket
187 * class. The given file descriptor must be
188 * valid, and when initialized, the InspSocket
189 * will be set with the given IP address
190 * and placed in CONNECTED state.
192 InspSocket(InspIRCd* SI, int newfd, const char* ip);
195 * This constructor is used to create a new
196 * socket, either listening for connections, or an outbound connection to another host.
197 * Note that if you specify a hostname in the 'ipaddr' parameter, this class will not
198 * connect. You must resolve your hostnames before passing them to InspSocket. To do so,
199 * you should use the nonblocking class 'Resolver'.
200 * @param ipaddr The IP to connect to, or bind to
201 * @param port The port number to connect to, or bind to
202 * @param listening true to listen on the given host:port pair, or false to connect to them
203 * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
205 InspSocket(InspIRCd* SI, const std::string &ipaddr, int port, bool listening, unsigned long maxtime);
208 * This method is called when an outbound
209 * connection on your socket is completed.
210 * @return false to abort the connection, true to continue
212 virtual bool OnConnected();
215 * This method is called when an error occurs.
216 * A closed socket in itself is not an error,
217 * however errors also generate close events.
218 * @param e The error type which occured
220 virtual void OnError(InspSocketError e);
223 * When an established connection is terminated,
224 * the OnDisconnect method is triggered.
226 virtual int OnDisconnect();
229 * When there is data waiting to be read on a
230 * socket, the OnDataReady() method is called.
231 * Within this method, you *MUST* call the Read()
232 * method to read any pending data. At its lowest
233 * level, this event is signalled by the core via
234 * the socket engine. If you return false from this
235 * function, the core removes your socket from its
236 * list and erases it from the socket engine, then
237 * calls InspSocket::Close() and deletes it.
238 * @return false to close the socket
240 virtual bool OnDataReady();
242 virtual bool OnWriteReady();
245 * When an outbound connection fails, and the
246 * attempt times out, you will receive this event.
247 * The method will trigger once maxtime seconds are
248 * reached (as given in the constructor) just
249 * before the socket's descriptor is closed.
250 * A failed DNS lookup may cause this event if
251 * the DNS server is not responding, as well as
252 * a failed connect() call, because DNS lookups are
253 * nonblocking as implemented by this class.
255 virtual void OnTimeout();
258 * Whenever close() is called, OnClose() will be
259 * called first. Please note that this means
260 * OnClose will be called alongside OnError(),
261 * OnTimeout(), and Close(), and also when
262 * cancelling a listening socket by calling
263 * the destructor indirectly.
265 virtual void OnClose();
268 * Reads all pending bytes from the socket
269 * into a char* array which can be up to
270 * 16 kilobytes in length.
272 virtual char* Read();
275 * Returns the IP address associated with
276 * this connection, or an empty string if
277 * no IP address exists.
282 * Writes a std::string to the socket. No carriage
283 * returns or linefeeds are appended to the string.
284 * @param data The data to send
286 virtual int Write(const std::string &data);
289 * If your socket is a listening socket, when a new
290 * connection comes in on the socket this method will
291 * be called. Given the new file descriptor in the
292 * parameters, and the IP, it is recommended you copy
293 * them to a new instance of your socket class,
296 * MySocket* newsocket = new MySocket(newfd,ip);
298 * Once you have done this, you can then associate the
299 * new socket with the core using Server::AddSocket().
301 virtual int OnIncomingConnection(int newfd, char* ip);
304 * Changes the socket's state. The core uses this
305 * to change socket states, and you should not call
308 void SetState(InspSocketState s);
311 * Call this to receive the next write event
312 * that comes along for this fd to the OnWriteReady
318 * Returns the current socket state.
320 InspSocketState GetState();
323 * Only the core should call this function.
324 * When called, it is assumed the socket is ready
325 * to read data, and the method call routes the
326 * event to the various methods of InspSocket
327 * for you to handle. This can also cause the
328 * socket's state to change.
333 * This method returns the socket's file descriptor
334 * as assigned by the operating system, or -1
335 * if no descriptor has been assigned.
340 * This method causes the socket to close, and may
341 * also be triggered by other methods such as OnTimeout
344 virtual void Close();
347 * The destructor may implicitly call OnClose(), and
348 * will close() and shutdown() the file descriptor
349 * used for this socket.
351 virtual ~InspSocket();
354 * This method attempts to connect to a hostname.
355 * This only occurs on a non-listening socket. This
356 * method is asyncronous.
358 virtual bool DoConnect();
361 * This method marks the socket closed.
362 * The next time the core examines a socket marked
363 * as closed, the socket will be closed and the
368 void HandleEvent(EventType et, int errornum = 0);