* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * InspIRCd: (C) 2002-2008 InspIRCd Development Team
* See: http://www.inspircd.org/wiki/index.php/Credits
*
* This program is free but copyrighted software; see
- * the file COPYING for details.
+ * the file COPYING for details.
*
* ---------------------------------------------------
*/
#ifndef __INSP_SOCKET_H__
#define __INSP_SOCKET_H__
-#include <sstream>
-#include <string>
-#include <deque>
-#include "dns.h"
-#include "inspircd_config.h"
-#include "socket.h"
-#include "inspsocket.h"
#include "timer.h"
/**
* States which a socket may be in
*/
-enum InspSocketState { I_DISCONNECTED, I_CONNECTING, I_CONNECTED, I_LISTENING, I_ERROR };
+enum BufferedSocketState
+{
+ /** Socket disconnected */
+ I_DISCONNECTED,
+ /** Socket connecting */
+ I_CONNECTING,
+ /** Socket fully connected */
+ I_CONNECTED,
+ /** Socket listening for connections */
+ I_LISTENING,
+ /** Socket has an error */
+ I_ERROR
+};
/**
* Error types which a socket may exhibit
*/
-enum InspSocketError { I_ERR_TIMEOUT, I_ERR_SOCKET, I_ERR_CONNECT, I_ERR_BIND, I_ERR_RESOLVE, I_ERR_WRITE, I_ERR_NOMOREFDS };
+enum BufferedSocketError
+{
+ /** Socket connect timed out */
+ I_ERR_TIMEOUT,
+ /** Socket could not be created */
+ I_ERR_SOCKET,
+ /** Socket could not connect (refused) */
+ 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
+};
-class InspSocket;
+/* Required forward declarations */
+class BufferedSocket;
class InspIRCd;
using irc::sockets::insp_sockaddr;
/** Used to time out socket connections
*/
-class SocketTimeout : public InspTimer
+class CoreExport SocketTimeout : public Timer
{
private:
- InspSocket* sock;
+ /** 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:
- SocketTimeout(int fd, InspIRCd* Instance, InspSocket* thesock, long secs_from_now, time_t now) : InspTimer(secs_from_now, now), sock(thesock), ServerInstance(Instance), sfd(fd) { };
+ /** Create a socket timeout class
+ * @param fd File descriptor of BufferedSocket
+ * @pram Instance server instance to attach to
+ * @param thesock BufferedSocket to attach to
+ * @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) { };
+ /** Handle tick event
+ */
virtual void Tick(time_t now);
};
/**
- * InspSocket is an extendable socket class which modules
+ * 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 InspSocket, you must inherit a class from it,
- * and use the InspSocket constructors to establish connections
+ * To use BufferedSocket, you must inherit a class from it,
+ * and use the BufferedSocket constructors to establish connections
* and bindings.
*/
-class InspSocket : public EventHandler
+class CoreExport BufferedSocket : public EventHandler
{
public:
+ /**
+ * Bind IP
+ */
std::string cbindip;
+ /**
+ * Is hooked by a module for low level IO
+ */
bool IsIOHooked;
+ /**
+ * Instance we were created by
+ */
InspIRCd* Instance;
+ /**
+ * Timeout class or NULL
+ */
SocketTimeout* Timeout;
+ /**
+ * Timeout length
+ */
unsigned long timeout_val;
+ /**
+ * Socket output buffer (binary safe)
+ */
std::deque<std::string> outbuffer;
/**
* listening, connecting, connected
* or error.
*/
- InspSocketState state;
+ BufferedSocketState state;
/**
* This value is true if the
* socket has timed out.
*/
- bool timeout;
+ bool timeout;
/**
* Socket input buffer, used by read(). The class which
- * extends InspSocket is expected to implement an extendable
+ * 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.
*/
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.
*/
- InspSocket(InspIRCd* SI);
+ BufferedSocket(InspIRCd* SI);
/**
* This constructor is used to associate
- * an existing connecting with an InspSocket
+ * an existing connecting with an BufferedSocket
* class. The given file descriptor must be
- * valid, and when initialized, the InspSocket
+ * valid, and when initialized, the BufferedSocket
* will be set with the given IP address
* and placed in CONNECTED state.
*/
- InspSocket(InspIRCd* SI, int newfd, const char* ip);
+ 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.
* 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 InspSocket. To do so,
+ * 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 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.
*/
- InspSocket(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, bool listening, unsigned long maxtime, const std::string &connectbindip = "");
/**
* This method is called when an outbound
* however errors also generate close events.
* @param e The error type which occured
*/
- virtual void OnError(InspSocketError e);
+ virtual void OnError(BufferedSocketError e);
/**
* When an established connection is terminated,
* 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 InspSocket::Close() and deletes it.
+ * 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();
/**
* into a char* array which can be up to
* 16 kilobytes in length.
*/
- virtual char* Read();
+ virtual const char* Read();
/**
* Returns the IP address associated with
* returns or linefeeds are appended to the string.
* @param data The data to send
*/
- virtual int Write(const std::string &data);
+ virtual void Write(const std::string &data);
/**
* If your socket is a listening socket, when a new
* to change socket states, and you should not call
* it directly.
*/
- void SetState(InspSocketState s);
+ void SetState(BufferedSocketState s);
/**
* Call this to receive the next write event
/**
* Returns the current socket state.
*/
- InspSocketState GetState();
+ 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 InspSocket
+ * event to the various methods of BufferedSocket
* for you to handle. This can also cause the
* socket's state to change.
*/
* will close() and shutdown() the file descriptor
* used for this socket.
*/
- virtual ~InspSocket();
+ virtual ~BufferedSocket();
/**
* This method attempts to connect to a hostname.
*/
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.
+ /** Handle event from EventHandler parent class
*/
- void MarkAsClosed();
-
void HandleEvent(EventType et, int errornum = 0);
+ /** Returns true if this socket is readable
+ */
bool Readable();
};
#endif
+
projects / user / henk / code / inspircd.git / blobdiff