* | 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
};
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
*/
class CoreExport SocketTimeout : public Timer
/** 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 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) { };
+
/** Handle tick event
*/
virtual void Tick(time_t now);
* 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.
+ * that all use is fully asynchronous.
+ *
+ * To use BufferedSocket, you must inherit a class from it.
*/
class CoreExport BufferedSocket : public EventHandler
{
public:
- /**
- * Bind IP
+ /** Bind IP
*/
std::string cbindip;
- /**
- * Is hooked by a module for low level IO
+ /** Instance we were created by
*/
- bool IsIOHooked;
-
- /**
- * Instance we were created by
- */
- InspIRCd* Instance;
+ InspIRCd* ServerInstance;
- /**
- * Timeout class or NULL
+ /** Timeout class or NULL
*/
SocketTimeout* Timeout;
- /**
- * Timeout length
- */
- unsigned long timeout_val;
-
- /**
- * Socket output buffer (binary safe)
+ /** Socket output buffer (binary safe)
*/
std::deque<std::string> outbuffer;
- /**
- * The hostname connected to
+ /** The hostname connected to
*/
char host[MAXBUF];
- /**
- * The port connected to, or the port
- * this socket is listening on
+ /** The port connected to
*/
int port;
*/
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
socklen_t length;
/** Flushes the write buffer
+ * @returns true if the writing failed, false if it was successful
*/
bool FlushWriteBuffer();
* more information without application-level queueing
* which was required in older software.
*/
- void SetQueues(int nfd);
+ void SetQueues();
/** When the socket has been marked as closing, this flag
* will be set to true, then the next time the socket is
*/
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
*/
bool BindAddr(const std::string &ip);
+ /** (really) Try bind to a given IP setup. For internal use only.
+ */
+ bool DoBindMagic(const std::string ¤t_ip);
+
/**
* The default constructor does nothing
* and should not be used.
BufferedSocket(InspIRCd* SI, int newfd, const char* ip);
/**
- * This constructor is used to create a new
- * socket, either listening for connections, or an outbound connection to another host.
+ * This constructor is used to create a new 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 port The port number to connect to
* @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.
*/
- BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int port, bool listening, unsigned long maxtime, const std::string &connectbindip = "");
+ BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int port, unsigned long maxtime, const std::string &connectbindip = "");
/**
* This method is called when an outbound
virtual bool OnDataReady();
/**
- * When it is ok to write to the socket, and a
+ * 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
+ * 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().
+ * other end of the socket.
+ *
+ * Further write events will not be triggered
+ * unless you call SocketEngine::WantWrite().
+ *
+ * The default behaviour of this method is to
+ * flush the write buffer, respecting the IO
+ * hooking modules.
+ *
+ * XXX: this used to be virtual, ask us if you need it to be so.
* @return false to close the socket
*/
- virtual bool OnWriteReady();
+ bool OnWriteReady();
/**
* When an outbound connection fails, and the
* 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.
+ * OnTimeout(), and Close().
*/
virtual void OnClose();
* 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);
+ virtual void Write(const std::string &data);
/**
* Changes the socket's state. The core uses this
*/
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.
+ /** Mark a socket as being connected and call appropriate events.
*/
- int GetFd();
+ bool InternalMarkConnected();
/**
* This method causes the socket to close, and may
/**
* 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!
+ * This method is asyncronous.
+ * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
*/
- void MarkAsClosed();
+ virtual bool DoConnect(unsigned long maxtime);
/** Handle event from EventHandler parent class
*/
};
#endif
-
projects / user / henk / code / inspircd.git / blobdiff