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
73 /** Server instance creating the timeout class
75 InspIRCd* ServerInstance;
77 /** File descriptor of class this is attached to
82 /** Create a socket timeout class
83 * @param fd File descriptor of BufferedSocket
84 * @pram Instance server instance to attach to
85 * @param thesock BufferedSocket to attach to
86 * @param secs_from_now Seconds from now to time out
87 * @param now The current time
89 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) { };
93 virtual void Tick(time_t now);
97 * BufferedSocket is an extendable socket class which modules
98 * can use for TCP socket support. It is fully integrated
99 * into InspIRCds socket loop and attaches its sockets to
100 * the core's instance of the SocketEngine class, meaning
101 * that all use is fully asynchronous.
103 * To use BufferedSocket, you must inherit a class from it.
105 class CoreExport BufferedSocket : public EventHandler
113 /** Instance we were created by
117 /** Timeout class or NULL
119 SocketTimeout* Timeout;
121 /** Socket output buffer (binary safe)
123 std::deque<std::string> outbuffer;
125 /** The hostname connected to
129 /** The port connected to
134 * The state for this socket, either
135 * listening, connecting, connected
138 BufferedSocketState state;
141 * The IP address being connected
142 * to stored in string form for
143 * easy retrieval by accessors.
148 * Used by accept() to indicate the
149 * sizes of the sockaddr_in structures
153 /** Flushes the write buffer
154 * @returns true if the writing failed, false if it was successful
156 bool FlushWriteBuffer();
158 /** Set the queue sizes
159 * This private method sets the operating system queue
160 * sizes for this socket to 65535 so that it can queue
161 * more information without application-level queueing
162 * which was required in older software.
166 /** When the socket has been marked as closing, this flag
167 * will be set to true, then the next time the socket is
168 * examined, the socket is deleted and closed.
174 * @param ip IP to bind to
175 * @return True is the binding succeeded
177 bool BindAddr(const std::string &ip);
180 * The default constructor does nothing
181 * and should not be used.
183 BufferedSocket(InspIRCd* SI);
186 * This constructor is used to associate
187 * an existing connecting with an BufferedSocket
188 * class. The given file descriptor must be
189 * valid, and when initialized, the BufferedSocket
190 * will be set with the given IP address
191 * and placed in CONNECTED state.
193 BufferedSocket(InspIRCd* SI, int newfd, const char* ip);
196 * This constructor is used to create a new 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 BufferedSocket. 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
202 * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
203 * @param connectbindip When creating an outbound connection, the IP to bind the connection to. If not defined, the port is not bound.
204 * @return On exit, GetState() returns I_ERROR if an error occured, and errno can be used to read the socket error.
206 BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int port, unsigned long maxtime, const std::string &connectbindip = "");
209 * This method is called when an outbound
210 * connection on your socket is completed.
211 * @return false to abort the connection, true to continue
213 virtual bool OnConnected();
216 * This method is called when an error occurs.
217 * A closed socket in itself is not an error,
218 * however errors also generate close events.
219 * @param e The error type which occured
221 virtual void OnError(BufferedSocketError e);
224 * When an established connection is terminated,
225 * the OnDisconnect method is triggered.
227 virtual int OnDisconnect();
230 * When there is data waiting to be read on a
231 * socket, the OnDataReady() method is called.
232 * Within this method, you *MUST* call the Read()
233 * method to read any pending data. At its lowest
234 * level, this event is signalled by the core via
235 * the socket engine. If you return false from this
236 * function, the core removes your socket from its
237 * list and erases it from the socket engine, then
238 * calls BufferedSocket::Close() and deletes it.
239 * @return false to close the socket
241 virtual bool OnDataReady();
244 * When it is ok to write to the socket, and a
245 * write event was requested, this method is
248 * Within this method you should call
249 * write() or send() etc, to send data to the
250 * other end of the socket.
252 * Further write events will not be triggered
253 * unless you call SocketEngine::WantWrite().
255 * The default behaviour of this method is to
256 * flush the write buffer, respecting the IO
259 * XXX: this used to be virtual, ask us if you need it to be so.
260 * @return false to close the socket
265 * When an outbound connection fails, and the
266 * attempt times out, you will receive this event.
267 * The method will trigger once maxtime seconds are
268 * reached (as given in the constructor) just
269 * before the socket's descriptor is closed.
270 * A failed DNS lookup may cause this event if
271 * the DNS server is not responding, as well as
272 * a failed connect() call, because DNS lookups are
273 * nonblocking as implemented by this class.
275 virtual void OnTimeout();
278 * Whenever close() is called, OnClose() will be
279 * called first. Please note that this means
280 * OnClose will be called alongside OnError(),
281 * OnTimeout(), and Close().
283 virtual void OnClose();
286 * Reads all pending bytes from the socket
287 * into a char* array which can be up to
288 * 16 kilobytes in length.
290 virtual const char* Read();
293 * Returns the IP address associated with
294 * this connection, or an empty string if
295 * no IP address exists.
300 * Writes a std::string to the socket. No carriage
301 * returns or linefeeds are appended to the string.
302 * @param data The data to send
304 virtual void Write(const std::string &data);
307 * Changes the socket's state. The core uses this
308 * to change socket states, and you should not call
311 void SetState(BufferedSocketState s);
314 * Returns the current socket state.
316 BufferedSocketState GetState();
318 /** Mark a socket as being connected and call appropriate events.
320 bool InternalMarkConnected();
323 * This method causes the socket to close, and may
324 * also be triggered by other methods such as OnTimeout
327 virtual void Close();
330 * The destructor may implicitly call OnClose(), and
331 * will close() and shutdown() the file descriptor
332 * used for this socket.
334 virtual ~BufferedSocket();
337 * This method attempts to connect to a hostname.
338 * This method is asyncronous.
339 * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
341 virtual bool DoConnect(unsigned long maxtime);
343 /** Handle event from EventHandler parent class
345 void HandleEvent(EventType et, int errornum = 0);
347 /** Returns true if this socket is readable