1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 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__
20 * States which a socket may be in
22 enum BufferedSocketState
24 /** Socket disconnected */
26 /** Socket connecting */
28 /** Socket fully connected */
30 /** Socket has an error */
35 * Error types which a socket may exhibit
37 enum BufferedSocketError
39 /** Socket connect timed out */
41 /** Socket could not be created */
43 /** Socket could not connect (refused) */
45 /** Socket could not bind to local port/ip */
47 /** Socket could not reslve host (depreciated) */
49 /** Socket could not write data */
51 /** No more file descriptors left to create socket! */
55 /* Required forward declarations */
59 using irc::sockets::insp_sockaddr;
60 using irc::sockets::insp_inaddr;
61 using irc::sockets::insp_ntoa;
62 using irc::sockets::insp_aton;
64 /** Used to time out socket connections
66 class CoreExport SocketTimeout : public Timer
69 /** BufferedSocket the class is attached to
72 /** Server instance creating the timeout class
74 InspIRCd* ServerInstance;
75 /** File descriptor of class this is attached to
79 /** Create a socket timeout class
80 * @param fd File descriptor of BufferedSocket
81 * @pram Instance server instance to attach to
82 * @param thesock BufferedSocket to attach to
83 * @param secs_from_now Seconds from now to time out
84 * @param now The current time
86 SocketTimeout(int fd, InspIRCd* Instance, BufferedSocket* thesock, long secs_from_now, time_t now) : Timer(secs_from_now, now), sock(thesock), ServerInstance(Instance), sfd(fd) { };
89 virtual void Tick(time_t now);
93 * BufferedSocket is an extendable socket class which modules
94 * can use for TCP socket support. It is fully integrated
95 * into InspIRCds socket loop and attaches its sockets to
96 * the core's instance of the SocketEngine class, meaning
97 * that any sockets you create have the same power and
98 * abilities as a socket created by the core itself.
99 * To use BufferedSocket, you must inherit a class from it,
100 * and use the BufferedSocket constructors to establish connections
103 class CoreExport BufferedSocket : public EventHandler
111 /** Instance we were created by
115 /** Timeout class or NULL
117 SocketTimeout* Timeout;
121 unsigned long timeout_val;
123 /** Socket output buffer (binary safe)
125 std::deque<std::string> outbuffer;
127 /** The hostname connected to
131 /** The port connected to
136 * The state for this socket, either
137 * listening, connecting, connected
140 BufferedSocketState state;
143 * The IP address being connected
144 * to stored in string form for
145 * easy retrieval by accessors.
150 * Used by accept() to indicate the
151 * sizes of the sockaddr_in structures
155 /** Flushes the write buffer
156 * @returns true if the writing failed, false if it was successful
158 bool FlushWriteBuffer();
160 /** Set the queue sizes
161 * This private method sets the operating system queue
162 * sizes for this socket to 65535 so that it can queue
163 * more information without application-level queueing
164 * which was required in older software.
166 void SetQueues(int nfd);
168 /** When the socket has been marked as closing, this flag
169 * will be set to true, then the next time the socket is
170 * examined, the socket is deleted and closed.
176 * @param ip IP to bind to
177 * @return True is the binding succeeded
179 bool BindAddr(const std::string &ip);
182 * The default constructor does nothing
183 * and should not be used.
185 BufferedSocket(InspIRCd* SI);
188 * This constructor is used to associate
189 * an existing connecting with an BufferedSocket
190 * class. The given file descriptor must be
191 * valid, and when initialized, the BufferedSocket
192 * will be set with the given IP address
193 * and placed in CONNECTED state.
195 BufferedSocket(InspIRCd* SI, int newfd, const char* ip);
198 * This constructor is used to create a new outbound connection to another host.
199 * Note that if you specify a hostname in the 'ipaddr' parameter, this class will not
200 * connect. You must resolve your hostnames before passing them to BufferedSocket. To do so,
201 * you should use the nonblocking class 'Resolver'.
202 * @param ipaddr The IP to connect to, or bind to
203 * @param port The port number to connect to
204 * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
205 * @param connectbindip When creating an outbound connection, the IP to bind the connection to. If not defined, the port is not bound.
206 * @return On exit, GetState() returns I_ERROR if an error occured, and errno can be used to read the socket error.
208 BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int port, unsigned long maxtime, const std::string &connectbindip = "");
211 * This method is called when an outbound
212 * connection on your socket is completed.
213 * @return false to abort the connection, true to continue
215 virtual bool OnConnected();
218 * This method is called when an error occurs.
219 * A closed socket in itself is not an error,
220 * however errors also generate close events.
221 * @param e The error type which occured
223 virtual void OnError(BufferedSocketError e);
226 * When an established connection is terminated,
227 * the OnDisconnect method is triggered.
229 virtual int OnDisconnect();
232 * When there is data waiting to be read on a
233 * socket, the OnDataReady() method is called.
234 * Within this method, you *MUST* call the Read()
235 * method to read any pending data. At its lowest
236 * level, this event is signalled by the core via
237 * the socket engine. If you return false from this
238 * function, the core removes your socket from its
239 * list and erases it from the socket engine, then
240 * calls BufferedSocket::Close() and deletes it.
241 * @return false to close the socket
243 virtual bool OnDataReady();
246 * When it is ok to write to the socket, and a
247 * write event was requested, this method is
250 * Within this method you should call
251 * write() or send() etc, to send data to the
252 * other end of the socket.
254 * Further write events will not be triggered
255 * unless you call WantWrite().
257 * The default behaviour of this method is to
258 * flush the write buffer, respecting the IO
261 * XXX: this used to be virtual, ask us if you need it to be so.
262 * @return false to close the socket
267 * When an outbound connection fails, and the
268 * attempt times out, you will receive this event.
269 * The method will trigger once maxtime seconds are
270 * reached (as given in the constructor) just
271 * before the socket's descriptor is closed.
272 * A failed DNS lookup may cause this event if
273 * the DNS server is not responding, as well as
274 * a failed connect() call, because DNS lookups are
275 * nonblocking as implemented by this class.
277 virtual void OnTimeout();
280 * Whenever close() is called, OnClose() will be
281 * called first. Please note that this means
282 * OnClose will be called alongside OnError(),
283 * OnTimeout(), and Close().
285 virtual void OnClose();
288 * Reads all pending bytes from the socket
289 * into a char* array which can be up to
290 * 16 kilobytes in length.
292 virtual const char* Read();
295 * Returns the IP address associated with
296 * this connection, or an empty string if
297 * no IP address exists.
302 * Writes a std::string to the socket. No carriage
303 * returns or linefeeds are appended to the string.
304 * @param data The data to send
306 virtual void Write(const std::string &data);
309 * Changes the socket's state. The core uses this
310 * to change socket states, and you should not call
313 void SetState(BufferedSocketState s);
316 * Call this to receive the next write event
317 * that comes along for this fd to the OnWriteReady
323 * Returns the current socket state.
325 BufferedSocketState GetState();
328 * Only the core should call this function.
329 * When called, it is assumed the socket is ready
330 * to read data, and the method call routes the
331 * event to the various methods of BufferedSocket
332 * for you to handle. This can also cause the
333 * socket's state to change.
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 ~BufferedSocket();
352 * This method attempts to connect to a hostname.
353 * This method is asyncronous.
355 virtual bool DoConnect();
357 /** Handle event from EventHandler parent class
359 void HandleEvent(EventType et, int errornum = 0);
361 /** Returns true if this socket is readable