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 all use is fully asynchronous.
99 * To use BufferedSocket, you must inherit a class from it.
101 class CoreExport BufferedSocket : public EventHandler
109 /** Instance we were created by
113 /** Timeout class or NULL
115 SocketTimeout* Timeout;
117 /** Socket output buffer (binary safe)
119 std::deque<std::string> outbuffer;
121 /** The hostname connected to
125 /** The port connected to
130 * The state for this socket, either
131 * listening, connecting, connected
134 BufferedSocketState state;
137 * The IP address being connected
138 * to stored in string form for
139 * easy retrieval by accessors.
144 * Used by accept() to indicate the
145 * sizes of the sockaddr_in structures
149 /** Flushes the write buffer
150 * @returns true if the writing failed, false if it was successful
152 bool FlushWriteBuffer();
154 /** Set the queue sizes
155 * This private method sets the operating system queue
156 * sizes for this socket to 65535 so that it can queue
157 * more information without application-level queueing
158 * which was required in older software.
162 /** When the socket has been marked as closing, this flag
163 * will be set to true, then the next time the socket is
164 * examined, the socket is deleted and closed.
170 * @param ip IP to bind to
171 * @return True is the binding succeeded
173 bool BindAddr(const std::string &ip);
176 * The default constructor does nothing
177 * and should not be used.
179 BufferedSocket(InspIRCd* SI);
182 * This constructor is used to associate
183 * an existing connecting with an BufferedSocket
184 * class. The given file descriptor must be
185 * valid, and when initialized, the BufferedSocket
186 * will be set with the given IP address
187 * and placed in CONNECTED state.
189 BufferedSocket(InspIRCd* SI, int newfd, const char* ip);
192 * This constructor is used to create a new outbound connection to another host.
193 * Note that if you specify a hostname in the 'ipaddr' parameter, this class will not
194 * connect. You must resolve your hostnames before passing them to BufferedSocket. To do so,
195 * you should use the nonblocking class 'Resolver'.
196 * @param ipaddr The IP to connect to, or bind to
197 * @param port The port number to connect to
198 * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
199 * @param connectbindip When creating an outbound connection, the IP to bind the connection to. If not defined, the port is not bound.
200 * @return On exit, GetState() returns I_ERROR if an error occured, and errno can be used to read the socket error.
202 BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int port, unsigned long maxtime, const std::string &connectbindip = "");
205 * This method is called when an outbound
206 * connection on your socket is completed.
207 * @return false to abort the connection, true to continue
209 virtual bool OnConnected();
212 * This method is called when an error occurs.
213 * A closed socket in itself is not an error,
214 * however errors also generate close events.
215 * @param e The error type which occured
217 virtual void OnError(BufferedSocketError e);
220 * When an established connection is terminated,
221 * the OnDisconnect method is triggered.
223 virtual int OnDisconnect();
226 * When there is data waiting to be read on a
227 * socket, the OnDataReady() method is called.
228 * Within this method, you *MUST* call the Read()
229 * method to read any pending data. At its lowest
230 * level, this event is signalled by the core via
231 * the socket engine. If you return false from this
232 * function, the core removes your socket from its
233 * list and erases it from the socket engine, then
234 * calls BufferedSocket::Close() and deletes it.
235 * @return false to close the socket
237 virtual bool OnDataReady();
240 * When it is ok to write to the socket, and a
241 * write event was requested, this method is
244 * Within this method you should call
245 * write() or send() etc, to send data to the
246 * other end of the socket.
248 * Further write events will not be triggered
249 * unless you call SocketEngine::WantWrite().
251 * The default behaviour of this method is to
252 * flush the write buffer, respecting the IO
255 * XXX: this used to be virtual, ask us if you need it to be so.
256 * @return false to close the socket
261 * When an outbound connection fails, and the
262 * attempt times out, you will receive this event.
263 * The method will trigger once maxtime seconds are
264 * reached (as given in the constructor) just
265 * before the socket's descriptor is closed.
266 * A failed DNS lookup may cause this event if
267 * the DNS server is not responding, as well as
268 * a failed connect() call, because DNS lookups are
269 * nonblocking as implemented by this class.
271 virtual void OnTimeout();
274 * Whenever close() is called, OnClose() will be
275 * called first. Please note that this means
276 * OnClose will be called alongside OnError(),
277 * OnTimeout(), and Close().
279 virtual void OnClose();
282 * Reads all pending bytes from the socket
283 * into a char* array which can be up to
284 * 16 kilobytes in length.
286 virtual const char* Read();
289 * Returns the IP address associated with
290 * this connection, or an empty string if
291 * no IP address exists.
296 * Writes a std::string to the socket. No carriage
297 * returns or linefeeds are appended to the string.
298 * @param data The data to send
300 virtual void Write(const std::string &data);
303 * Changes the socket's state. The core uses this
304 * to change socket states, and you should not call
307 void SetState(BufferedSocketState s);
310 * Returns the current socket state.
312 BufferedSocketState GetState();
315 * Only the core should call this function.
316 * When called, it is assumed the socket is ready
317 * to read data, and the method call routes the
318 * event to the various methods of BufferedSocket
319 * for you to handle. This can also cause the
320 * socket's state to change.
325 * This method causes the socket to close, and may
326 * also be triggered by other methods such as OnTimeout
329 virtual void Close();
332 * The destructor may implicitly call OnClose(), and
333 * will close() and shutdown() the file descriptor
334 * used for this socket.
336 virtual ~BufferedSocket();
339 * This method attempts to connect to a hostname.
340 * This method is asyncronous.
341 * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
343 virtual bool DoConnect(unsigned long maxtime);
345 /** Handle event from EventHandler parent class
347 void HandleEvent(EventType et, int errornum = 0);
349 /** Returns true if this socket is readable