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__
20 #include <sys/types.h>
21 #include <sys/socket.h>
22 #include <netinet/in.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
53 * The file descriptor of this socket
58 * The resolver for this socket
63 * The hostname connected to
68 * The port connected to, or the port
69 * this socket is listening on
74 * The state for this socket, either
75 * listening, connecting, connected
78 InspSocketState state;
81 * The host being connected to,
87 * The host being connected to,
93 * When this time is reached,
94 * the socket times out if it is
95 * in the CONNECTING state
100 * This value is true if the
101 * socket has timed out.
106 * Socket input buffer, used by read(). The class which
107 * extends InspSocket is expected to implement an extendable
108 * buffer which can grow much larger than 64k,
109 * this buffer is just designed to be temporary storage.
115 * The IP address being connected
116 * to stored in string form for
117 * easy retrieval by accessors.
122 * Client sockaddr structure used
128 * Server sockaddr structure used
134 * Used by accept() to indicate the
135 * sizes of the sockaddr_in structures
139 /** Flushes the write buffer
141 bool FlushWriteBuffer();
143 /** Set the queue sizes
144 * This private method sets the operating system queue
145 * sizes for this socket to 65535 so that it can queue
146 * more information without application-level queueing
147 * which was required in older software.
149 void SetQueues(int nfd);
151 /** When the socket has been marked as closing, this flag
152 * will be set to true, then the next time the socket is
153 * examined, the socket is deleted and closed.
160 * The default constructor does nothing
161 * and should not be used.
166 * This constructor is used to associate
167 * an existing connecting with an InspSocket
168 * class. The given file descriptor must be
169 * valid, and when initialized, the InspSocket
170 * will be set with the given IP address
171 * and placed in CONNECTED state.
173 InspSocket(int newfd, char* ip);
176 * This constructor is used to create a new
177 * socket, either listening for connections, or an outbound connection to another host.
178 * Note that if you specify a hostname in the 'host' parameter, then there will be an extra
179 * step involved (a nonblocking DNS lookup) which will cause your connection to be established
180 * slower than if it was an IP. Therefore, use an IP address where it is available instead.
181 * @param host The hostname to connect to, or bind to
182 * @param port The port number to connect to, or bind to
183 * @param listening true to listen on the given host:port pair, or false to connect to them
184 * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
186 InspSocket(const std::string &host, int port, bool listening, unsigned long maxtime);
189 * This method is called when an outbound
190 * connection on your socket is completed.
191 * @return false to abort the connection, true to continue
193 virtual bool OnConnected();
196 * This method is called when an error occurs.
197 * A closed socket in itself is not an error,
198 * however errors also generate close events.
199 * @param e The error type which occured
201 virtual void OnError(InspSocketError e);
204 * When an established connection is terminated,
205 * the OnDisconnect method is triggered.
207 virtual int OnDisconnect();
210 * When there is data waiting to be read on a
211 * socket, the OnDataReady() method is called.
212 * Within this method, you *MUST* call the Read()
213 * method to read any pending data. At its lowest
214 * level, this event is signalled by the core via
215 * the socket engine. If you return false from this
216 * function, the core removes your socket from its
217 * list and erases it from the socket engine, then
218 * calls InspSocket::Close() and deletes it.
219 * @return false to close the socket
221 virtual bool OnDataReady();
224 * When an outbound connection fails, and the
225 * attempt times out, you will receive this event.
226 * The method will trigger once maxtime seconds are
227 * reached (as given in the constructor) just
228 * before the socket's descriptor is closed.
229 * A failed DNS lookup may cause this event if
230 * the DNS server is not responding, as well as
231 * a failed connect() call, because DNS lookups are
232 * nonblocking as implemented by this class.
234 virtual void OnTimeout();
237 * Whenever close() is called, OnClose() will be
238 * called first. Please note that this means
239 * OnClose will be called alongside OnError(),
240 * OnTimeout(), and Close(), and also when
241 * cancelling a listening socket by calling
242 * the destructor indirectly.
244 virtual void OnClose();
247 * Reads all pending bytes from the socket
248 * into a char* array which can be up to
249 * 16 kilobytes in length.
251 virtual char* Read();
254 * Returns the IP address associated with
255 * this connection, or an empty string if
256 * no IP address exists.
261 * This function checks if the socket has
262 * timed out yet, given the current time
264 * @return true if timed out, false if not timed out
266 bool Timeout(time_t current);
269 * Writes a std::string to the socket. No carriage
270 * returns or linefeeds are appended to the string.
271 * @param data The data to send
273 virtual int Write(const std::string &data);
276 * If your socket is a listening socket, when a new
277 * connection comes in on the socket this method will
278 * be called. Given the new file descriptor in the
279 * parameters, and the IP, it is recommended you copy
280 * them to a new instance of your socket class,
283 * MySocket* newsocket = new MySocket(newfd,ip);
285 * Once you have done this, you can then associate the
286 * new socket with the core using Server::AddSocket().
288 virtual int OnIncomingConnection(int newfd, char* ip);
291 * Changes the socket's state. The core uses this
292 * to change socket states, and you should not call
295 void SetState(InspSocketState s);
298 * Returns the current socket state.
300 InspSocketState GetState();
303 * Only the core should call this function.
304 * When called, it is assumed the socket is ready
305 * to read data, and the method call routes the
306 * event to the various methods of InspSocket
307 * for you to handle. This can also cause the
308 * socket's state to change.
313 * This method returns the socket's file descriptor
314 * as assigned by the operating system, or -1
315 * if no descriptor has been assigned.
320 * This method causes the socket to close, and may
321 * also be triggered by other methods such as OnTimeout
324 virtual void Close();
327 * The destructor may implicitly call OnClose(), and
328 * will close() and shutdown() the file descriptor
329 * used for this socket.
331 virtual ~InspSocket();
334 * This method attempts to resolve the hostname,
335 * if a hostname is given and not an IP,
336 * before a connection can occur. This method is
339 virtual bool DoResolve();
342 * This method attempts to connect to a hostname.
343 * This only occurs on a non-listening socket. This
344 * method is asyncronous.
346 virtual bool DoConnect();
349 * This method marks the socket closed.
350 * The next time the core examines a socket marked
351 * as closed, the socket will be closed and the