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 };
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 output buffer for this socket
120 * The IP address being connected
121 * to stored in string form for
122 * easy retrieval by accessors.
127 * Client sockaddr structure used
133 * Server sockaddr structure used
139 * Used by accept() to indicate the
140 * sizes of the sockaddr_in structures
144 /** Flushes the write buffer
146 void FlushWriteBuffer();
148 void SetQueues(int nfd);
153 * The default constructor does nothing
154 * and should not be used.
159 * This constructor is used to associate
160 * an existing connecting with an InspSocket
161 * class. The given file descriptor must be
162 * valid, and when initialized, the InspSocket
163 * will be set with the given IP address
164 * and placed in CONNECTED state.
166 InspSocket(int newfd, char* ip);
169 * This constructor is used to create a new
170 * socket, either listening for connections, or an outbound connection to another host.
171 * Note that if you specify a hostname in the 'host' parameter, then there will be an extra
172 * step involved (a nonblocking DNS lookup) which will cause your connection to be established
173 * slower than if it was an IP. Therefore, use an IP address where it is available instead.
174 * @param host The hostname to connect to, or bind to
175 * @param port The port number to connect to, or bind to
176 * @param listening true to listen on the given host:port pair, or false to connect to them
177 * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
179 InspSocket(std::string host, int port, bool listening, unsigned long maxtime);
182 * This method is called when an outbound
183 * connection on your socket is completed.
184 * @return false to abort the connection, true to continue
186 virtual bool OnConnected();
189 * This method is called when an error occurs.
190 * A closed socket in itself is not an error,
191 * however errors also generate close events.
192 * @param e The error type which occured
194 virtual void OnError(InspSocketError e);
197 * When an established connection is terminated,
198 * the OnDisconnect method is triggered.
200 virtual int OnDisconnect();
203 * When there is data waiting to be read on a
204 * socket, the OnDataReady() method is called.
205 * Within this method, you *MUST* call the Read()
206 * method to read any pending data. At its lowest
207 * level, this event is signalled by the core via
208 * the socket engine. If you return false from this
209 * function, the core removes your socket from its
210 * list and erases it from the socket engine, then
211 * calls InspSocket::Close() and deletes it.
212 * @return false to close the socket
214 virtual bool OnDataReady();
217 * When an outbound connection fails, and the
218 * attempt times out, you will receive this event.
219 * The method will trigger once maxtime seconds are
220 * reached (as given in the constructor) just
221 * before the socket's descriptor is closed.
222 * A failed DNS lookup may cause this event if
223 * the DNS server is not responding, as well as
224 * a failed connect() call, because DNS lookups are
225 * nonblocking as implemented by this class.
227 virtual void OnTimeout();
230 * Whenever close() is called, OnClose() will be
231 * called first. Please note that this means
232 * OnClose will be called alongside OnError(),
233 * OnTimeout(), and Close(), and also when
234 * cancelling a listening socket by calling
235 * the destructor indirectly.
237 virtual void OnClose();
240 * Reads all pending bytes from the socket
241 * into a char* array which can be up to
242 * 16 kilobytes in length.
244 virtual char* Read();
247 * Returns the IP address associated with
248 * this connection, or an empty string if
249 * no IP address exists.
254 * This function checks if the socket has
255 * timed out yet, given the current time
257 * @return true if timed out, false if not timed out
259 bool Timeout(time_t current);
262 * Writes a std::string to the socket. No carriage
263 * returns or linefeeds are appended to the string.
264 * @param data The data to send
266 virtual int Write(std::string data);
269 * If your socket is a listening socket, when a new
270 * connection comes in on the socket this method will
271 * be called. Given the new file descriptor in the
272 * parameters, and the IP, it is recommended you copy
273 * them to a new instance of your socket class,
276 * MySocket* newsocket = new MySocket(newfd,ip);
278 * Once you have done this, you can then associate the
279 * new socket with the core using Server::AddSocket().
281 virtual int OnIncomingConnection(int newfd, char* ip);
284 * Changes the socket's state. The core uses this
285 * to change socket states, and you should not call
288 void SetState(InspSocketState s);
291 * Returns the current socket state.
293 InspSocketState GetState();
296 * Only the core should call this function.
297 * When called, it is assumed the socket is ready
298 * to read data, and the method call routes the
299 * event to the various methods of InspSocket
300 * for you to handle. This can also cause the
301 * socket's state to change.
306 * This method returns the socket's file descriptor
307 * as assigned by the operating system, or -1
308 * if no descriptor has been assigned.
313 * This method causes the socket to close, and may
314 * also be triggered by other methods such as OnTimeout
317 virtual void Close();
320 * The destructor may implicitly call OnClose(), and
321 * will close() and shutdown() the file descriptor
322 * used for this socket.
324 virtual ~InspSocket();
326 virtual bool DoResolve();
327 virtual bool DoConnect();