* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
I_CONNECTING,
/** Socket fully connected */
I_CONNECTED,
- /** Socket listening for connections */
- I_LISTENING,
/** Socket has an error */
I_ERROR
};
*/
enum BufferedSocketError
{
+ /** No error */
+ I_ERR_NONE,
+ /** Socket was closed by peer */
+ I_ERR_DISCONNECT,
/** Socket connect timed out */
I_ERR_TIMEOUT,
/** Socket could not be created */
I_ERR_CONNECT,
/** Socket could not bind to local port/ip */
I_ERR_BIND,
- /** Socket could not reslve host (depreciated) */
- I_ERR_RESOLVE,
/** Socket could not write data */
I_ERR_WRITE,
/** No more file descriptors left to create socket! */
- I_ERR_NOMOREFDS
+ I_ERR_NOMOREFDS,
+ /** Some other error */
+ I_ERR_OTHER
};
/* Required forward declarations */
class BufferedSocket;
-class InspIRCd;
-
-using irc::sockets::insp_sockaddr;
-using irc::sockets::insp_inaddr;
-using irc::sockets::insp_ntoa;
-using irc::sockets::insp_aton;
/** Used to time out socket connections
*/
/** BufferedSocket the class is attached to
*/
BufferedSocket* sock;
- /** Server instance creating the timeout class
- */
- InspIRCd* ServerInstance;
+
/** File descriptor of class this is attached to
*/
int sfd;
+
public:
/** Create a socket timeout class
* @param fd File descriptor of BufferedSocket
* @param secs_from_now Seconds from now to time out
* @param now The current time
*/
- 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) { };
+ SocketTimeout(int fd, BufferedSocket* thesock, long secs_from_now, time_t now) : Timer(secs_from_now, now), sock(thesock), sfd(fd) { }
+
/** Handle tick event
*/
virtual void Tick(time_t now);
};
/**
- * BufferedSocket is an extendable socket class which modules
- * can use for TCP socket support. It is fully integrated
- * into InspIRCds socket loop and attaches its sockets to
- * the core's instance of the SocketEngine class, meaning
- * that any sockets you create have the same power and
- * abilities as a socket created by the core itself.
- * To use BufferedSocket, you must inherit a class from it,
- * and use the BufferedSocket constructors to establish connections
- * and bindings.
+ * StreamSocket is a class that wraps a TCP socket and handles send
+ * and receive queues, including passing them to IO hooks
*/
-class CoreExport BufferedSocket : public EventHandler
+class CoreExport StreamSocket : public EventHandler
{
+ /** Module that handles raw I/O for this socket, or NULL */
+ Module *IOHook;
+ /** Private send queue. Note that individual strings may be shared
+ */
+ std::deque<std::string> sendq;
+ /** Length, in bytes, of the sendq */
+ size_t sendq_len;
+ /** Error - if nonempty, the socket is dead, and this is the reason. */
+ std::string error;
+ protected:
+ std::string recvq;
public:
-
- /**
- * Bind IP
+ StreamSocket() : IOHook(NULL), sendq_len(0) {}
+ inline Module* GetIOHook() { return IOHook; }
+ inline void AddIOHook(Module* m) { IOHook = m; }
+ inline void DelIOHook() { IOHook = NULL; }
+ /** Handle event from socket engine.
+ * This will call OnDataReady if there is *new* data in recvq
*/
- std::string cbindip;
+ virtual void HandleEvent(EventType et, int errornum = 0);
+ /** Dispatched from HandleEvent */
+ virtual void DoRead();
+ /** Dispatched from HandleEvent */
+ virtual void DoWrite();
- /**
- * Is hooked by a module for low level IO
- */
- bool IsIOHooked;
+ /** Sets the error message for this socket. Once set, the socket is dead. */
+ void SetError(const std::string& err) { if (error.empty()) error = err; }
- /**
- * Instance we were created by
- */
- InspIRCd* Instance;
+ /** Gets the error message for this socket. */
+ const std::string& getError() const { return error; }
- /**
- * Timeout class or NULL
- */
- SocketTimeout* Timeout;
+ /** Called when new data is present in recvq */
+ virtual void OnDataReady() = 0;
+ /** Called when the socket gets an error from socket engine or IO hook */
+ virtual void OnError(BufferedSocketError e) = 0;
- /**
- * Timeout length
+ /** Send the given data out the socket, either now or when writes unblock
*/
- unsigned long timeout_val;
-
- /**
- * Socket output buffer (binary safe)
+ void WriteData(const std::string& data);
+ /** Convenience function: read a line from the socket
+ * @param line The line read
+ * @param delim The line delimiter
+ * @return true if a line was read
*/
- std::deque<std::string> outbuffer;
+ bool GetNextLine(std::string& line, char delim = '\n');
+ /** Useful for implementing sendq exceeded */
+ inline const size_t getSendQSize() const { return sendq_len; }
/**
- * The hostname connected to
+ * Close the socket, remove from socket engine, etc
*/
- char host[MAXBUF];
-
- /**
- * The port connected to, or the port
- * this socket is listening on
+ virtual void Close();
+ /** This ensures that close is called prior to destructor */
+ virtual CullResult cull();
+};
+/**
+ * BufferedSocket is an extendable socket class which modules
+ * can use for TCP socket support. It is fully integrated
+ * into InspIRCds socket loop and attaches its sockets to
+ * the core's instance of the SocketEngine class, meaning
+ * that all use is fully asynchronous.
+ *
+ * To use BufferedSocket, you must inherit a class from it.
+ */
+class CoreExport BufferedSocket : public StreamSocket
+{
+ public:
+ /** Timeout object or NULL
*/
- int port;
+ SocketTimeout* Timeout;
/**
* The state for this socket, either
*/
BufferedSocketState state;
- /**
- * This value is true if the
- * socket has timed out.
- */
- bool timeout;
-
- /**
- * Socket input buffer, used by read(). The class which
- * extends BufferedSocket is expected to implement an extendable
- * buffer which can grow much larger than 64k,
- * this buffer is just designed to be temporary storage.
- * space.
- */
- char ibuf[65535];
-
- /**
- * The IP address being connected
- * to stored in string form for
- * easy retrieval by accessors.
- */
- char IP[MAXBUF];
-
- /**
- * Used by accept() to indicate the
- * sizes of the sockaddr_in structures
- */
- socklen_t length;
-
- /** Flushes the write buffer
- */
- bool FlushWriteBuffer();
-
- /** Set the queue sizes
- * This private method sets the operating system queue
- * sizes for this socket to 65535 so that it can queue
- * more information without application-level queueing
- * which was required in older software.
- */
- void SetQueues(int nfd);
-
- /** When the socket has been marked as closing, this flag
- * will be set to true, then the next time the socket is
- * examined, the socket is deleted and closed.
- */
- bool ClosePending;
-
- /** Set to true when we're waiting for a write event.
- * If this is true and a write event comes in, we
- * call the write instead of the read method.
- */
- bool WaitingForWriteEvent;
-
- /**
- * Bind to an address
- * @param ip IP to bind to
- * @return True is the binding succeeded
- */
- bool BindAddr(const std::string &ip);
-
- /**
- * The default constructor does nothing
- * and should not be used.
- */
- BufferedSocket(InspIRCd* SI);
-
+ BufferedSocket();
/**
* This constructor is used to associate
* an existing connecting with an BufferedSocket
* class. The given file descriptor must be
* valid, and when initialized, the BufferedSocket
- * will be set with the given IP address
- * and placed in CONNECTED state.
+ * will be placed in CONNECTED state.
*/
- BufferedSocket(InspIRCd* SI, int newfd, const char* ip);
+ BufferedSocket(int newfd);
- /**
- * This constructor is used to create a new
- * socket, either listening for connections, or an outbound connection to another host.
- * Note that if you specify a hostname in the 'ipaddr' parameter, this class will not
- * connect. You must resolve your hostnames before passing them to BufferedSocket. To do so,
- * you should use the nonblocking class 'Resolver'.
- * @param ipaddr The IP to connect to, or bind to
- * @param port The port number to connect to, or bind to
- * @param listening true to listen on the given host:port pair, or false to connect to them
- * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
- * @param connectbindip When creating an outbound connection, the IP to bind the connection to. If not defined, the port is not bound.
- * @return On exit, GetState() returns I_ERROR if an error occured, and errno can be used to read the socket error.
+ /** Begin connection to the given address
+ * This will create a socket, register with socket engine, and start the asynchronous
+ * connection process. If an error is detected at this point (such as out of file descriptors),
+ * OnError will be called; otherwise, the state will become CONNECTING.
+ * @param dest Address to connect to
+ * @param bind Address to bind to (if NULL, no bind will be done)
+ * @param timeout Time to wait for connection
*/
- BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int port, bool listening, unsigned long maxtime, const std::string &connectbindip = "");
+ void DoConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip);
- /**
- * This method is called when an outbound
- * connection on your socket is completed.
- * @return false to abort the connection, true to continue
+ /** This method is called when an outbound connection on your socket is
+ * completed.
*/
- virtual bool OnConnected();
+ virtual void OnConnected();
- /**
- * This method is called when an error occurs.
- * A closed socket in itself is not an error,
- * however errors also generate close events.
- * @param e The error type which occured
+ /** When there is data waiting to be read on a socket, the OnDataReady()
+ * method is called.
*/
- virtual void OnError(BufferedSocketError e);
+ virtual void OnDataReady() = 0;
/**
- * When an established connection is terminated,
- * the OnDisconnect method is triggered.
- */
- virtual int OnDisconnect();
-
- /**
- * When there is data waiting to be read on a
- * socket, the OnDataReady() method is called.
- * Within this method, you *MUST* call the Read()
- * method to read any pending data. At its lowest
- * level, this event is signalled by the core via
- * the socket engine. If you return false from this
- * function, the core removes your socket from its
- * list and erases it from the socket engine, then
- * calls BufferedSocket::Close() and deletes it.
- * @return false to close the socket
- */
- virtual bool OnDataReady();
-
- /**
- * When it is ok to write to the socket, and a
- * write event was requested, this method is
- * triggered. Within this method you should call
- * write() or send() etc, to send data to the
- * other end of the socket. Further write events
- * will not be triggered unless you call WantWrite().
- * @return false to close the socket
- */
- virtual bool OnWriteReady();
-
- /**
- * When an outbound connection fails, and the
- * attempt times out, you will receive this event.
- * The method will trigger once maxtime seconds are
- * reached (as given in the constructor) just
- * before the socket's descriptor is closed.
- * A failed DNS lookup may cause this event if
- * the DNS server is not responding, as well as
- * a failed connect() call, because DNS lookups are
- * nonblocking as implemented by this class.
+ * When an outbound connection fails, and the attempt times out, you
+ * will receive this event. The method will trigger once maxtime
+ * seconds are reached (as given in the constructor) just before the
+ * socket's descriptor is closed. A failed DNS lookup may cause this
+ * event if the DNS server is not responding, as well as a failed
+ * connect() call, because DNS lookups are nonblocking as implemented by
+ * this class.
*/
virtual void OnTimeout();
- /**
- * Whenever close() is called, OnClose() will be
- * called first. Please note that this means
- * OnClose will be called alongside OnError(),
- * OnTimeout(), and Close(), and also when
- * cancelling a listening socket by calling
- * the destructor indirectly.
- */
- virtual void OnClose();
-
- /**
- * Reads all pending bytes from the socket
- * into a char* array which can be up to
- * 16 kilobytes in length.
- */
- virtual const char* Read();
-
- /**
- * Returns the IP address associated with
- * this connection, or an empty string if
- * no IP address exists.
- */
- std::string GetIP();
-
- /**
- * Writes a std::string to the socket. No carriage
- * returns or linefeeds are appended to the string.
- * @param data The data to send
- */
- virtual int Write(const std::string &data);
-
- /**
- * If your socket is a listening socket, when a new
- * connection comes in on the socket this method will
- * be called. Given the new file descriptor in the
- * parameters, and the IP, it is recommended you copy
- * them to a new instance of your socket class,
- * e.g.:
- *
- * MySocket* newsocket = new MySocket(newfd,ip);
- *
- * Once you have done this, you can then associate the
- * new socket with the core using Server::AddSocket().
- */
- virtual int OnIncomingConnection(int newfd, char* ip);
-
- /**
- * Changes the socket's state. The core uses this
- * to change socket states, and you should not call
- * it directly.
- */
- void SetState(BufferedSocketState s);
-
- /**
- * Call this to receive the next write event
- * that comes along for this fd to the OnWriteReady
- * method.
- */
- void WantWrite();
-
- /**
- * Returns the current socket state.
- */
- BufferedSocketState GetState();
-
- /**
- * Only the core should call this function.
- * When called, it is assumed the socket is ready
- * to read data, and the method call routes the
- * event to the various methods of BufferedSocket
- * for you to handle. This can also cause the
- * socket's state to change.
- */
- bool Poll();
-
- /**
- * This method returns the socket's file descriptor
- * as assigned by the operating system, or -1
- * if no descriptor has been assigned.
- */
- int GetFd();
-
- /**
- * This method causes the socket to close, and may
- * also be triggered by other methods such as OnTimeout
- * and OnError.
- */
- virtual void Close();
-
- /**
- * The destructor may implicitly call OnClose(), and
- * will close() and shutdown() the file descriptor
- * used for this socket.
- */
virtual ~BufferedSocket();
-
- /**
- * This method attempts to connect to a hostname.
- * This only occurs on a non-listening socket. This
- * method is asyncronous.
- */
- virtual bool DoConnect();
-
- /**
- * This method marks the socket closed.
- * The next time the core examines a socket marked
- * as closed, the socket will be closed and the
- * memory reclaimed.
- *
- * NOTE: This method is DEPRECIATED and will be
- * ignored if called!
- */
- void MarkAsClosed();
-
- /** Handle event from EventHandler parent class
- */
- void HandleEvent(EventType et, int errornum = 0);
-
- /** Returns true if this socket is readable
- */
- bool Readable();
+ protected:
+ virtual void DoWrite();
+ BufferedSocketError BeginConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned long timeout);
+ BufferedSocketError BeginConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip);
};
#endif
-
projects / user / henk / code / inspircd.git / blobdiff