include/inspsocket.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *          the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __INSP_SOCKET_H__
  15 #define __INSP_SOCKET_H__
  16
  17 #include "timer.h"
  18
  19 /**
  20  * States which a socket may be in
  21  */
  22 enum BufferedSocketState
  23 {
  24         /** Socket disconnected */
  25         I_DISCONNECTED,
  26         /** Socket connecting */
  27         I_CONNECTING,
  28         /** Socket fully connected */
  29         I_CONNECTED,
  30         /** Socket has an error */
  31         I_ERROR
  32 };
  33
  34 /**
  35  * Error types which a socket may exhibit
  36  */
  37 enum BufferedSocketError
  38 {
  39         /** Socket connect timed out */
  40         I_ERR_TIMEOUT,
  41         /** Socket could not be created */
  42         I_ERR_SOCKET,
  43         /** Socket could not connect (refused) */
  44         I_ERR_CONNECT,
  45         /** Socket could not bind to local port/ip */
  46         I_ERR_BIND,
  47         /** Socket could not reslve host (depreciated) */
  48         I_ERR_RESOLVE,
  49         /** Socket could not write data */
  50         I_ERR_WRITE,
  51         /** No more file descriptors left to create socket! */
  52         I_ERR_NOMOREFDS
  53 };
  54
  55 /* Required forward declarations */
  56 class BufferedSocket;
  57 class InspIRCd;
  58
  59 /** Used to time out socket connections
  60  */
  61 class CoreExport SocketTimeout : public Timer
  62 {
  63  private:
  64         /** BufferedSocket the class is attached to
  65          */
  66         BufferedSocket* sock;
  67
  68         /** Server instance creating the timeout class
  69          */
  70         InspIRCd* ServerInstance;
  71
  72         /** File descriptor of class this is attached to
  73          */
  74         int sfd;
  75
  76  public:
  77         /** Create a socket timeout class
  78          * @param fd File descriptor of BufferedSocket
  79          * @pram Instance server instance to attach to
  80          * @param thesock BufferedSocket to attach to
  81          * @param secs_from_now Seconds from now to time out
  82          * @param now The current time
  83          */
  84         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) { };
  85
  86         /** Handle tick event
  87          */
  88         virtual void Tick(time_t now);
  89 };
  90
  91 /**
  92  * BufferedSocket is an extendable socket class which modules
  93  * can use for TCP socket support. It is fully integrated
  94  * into InspIRCds socket loop and attaches its sockets to
  95  * the core's instance of the SocketEngine class, meaning
  96  * that all use is fully asynchronous.
  97  *
  98  * To use BufferedSocket, you must inherit a class from it.
  99  */
 100 class CoreExport BufferedSocket : public EventHandler
 101 {
 102  public:
 103
 104         /** Bind IP
 105          */
 106         std::string cbindip;
 107
 108         /** Instance we were created by
 109          */
 110         InspIRCd* ServerInstance;
 111
 112         /** Timeout class or NULL
 113          */
 114         SocketTimeout* Timeout;
 115
 116         /** Socket output buffer (binary safe)
 117          */
 118         std::deque<std::string> outbuffer;
 119
 120         /** The hostname connected to
 121          */
 122         char host[MAXBUF];
 123
 124         /** The port connected to
 125          */
 126         int port;
 127
 128         /**
 129          * The state for this socket, either
 130          * listening, connecting, connected
 131          * or error.
 132          */
 133         BufferedSocketState state;
 134
 135         /**
 136          * The IP address being connected
 137          * to stored in string form for
 138          * easy retrieval by accessors.
 139          */
 140         char IP[MAXBUF];
 141
 142         /**
 143          * Used by accept() to indicate the
 144          * sizes of the sockaddr_in structures
 145          */
 146         socklen_t length;
 147
 148         /** Flushes the write buffer
 149          * @returns true if the writing failed, false if it was successful
 150          */
 151         bool FlushWriteBuffer();
 152
 153         /** Set the queue sizes
 154          * This private method sets the operating system queue
 155          * sizes for this socket to 65535 so that it can queue
 156          * more information without application-level queueing
 157          * which was required in older software.
 158          */
 159         void SetQueues();
 160
 161         /** When the socket has been marked as closing, this flag
 162          * will be set to true, then the next time the socket is
 163          * examined, the socket is deleted and closed.
 164          */
 165         bool ClosePending;
 166
 167         /**
 168          * Bind to an address
 169          * @param ip IP to bind to
 170          * @return True is the binding succeeded
 171          */
 172         bool BindAddr(const std::string &ip);
 173
 174         /**
 175          * The default constructor does nothing
 176          * and should not be used.
 177          */
 178         BufferedSocket(InspIRCd* SI);
 179
 180         /**
 181          * This constructor is used to associate
 182          * an existing connecting with an BufferedSocket
 183          * class. The given file descriptor must be
 184          * valid, and when initialized, the BufferedSocket
 185          * will be set with the given IP address
 186          * and placed in CONNECTED state.
 187          */
 188         BufferedSocket(InspIRCd* SI, int newfd, const char* ip);
 189
 190         /**
 191          * This constructor is used to create a new outbound connection to another host.
 192          * Note that if you specify a hostname in the 'ipaddr' parameter, this class will not
 193          * connect. You must resolve your hostnames before passing them to BufferedSocket. To do so,
 194          * you should use the nonblocking class 'Resolver'.
 195          * @param ipaddr The IP to connect to, or bind to
 196          * @param port The port number to connect to
 197          * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
 198          * @param connectbindip When creating an outbound connection, the IP to bind the connection to. If not defined, the port is not bound.
 199          * @return On exit, GetState() returns I_ERROR if an error occured, and errno can be used to read the socket error.
 200          */
 201         BufferedSocket(InspIRCd* SI, const std::string &ipaddr, int port, unsigned long maxtime, const std::string &connectbindip = "");
 202
 203         /**
 204          * This method is called when an outbound
 205          * connection on your socket is completed.
 206          * @return false to abort the connection, true to continue
 207          */
 208         virtual bool OnConnected();
 209
 210         /**
 211          * This method is called when an error occurs.
 212          * A closed socket in itself is not an error,
 213          * however errors also generate close events.
 214          * @param e The error type which occured
 215          */
 216         virtual void OnError(BufferedSocketError e);
 217
 218         /**
 219          * When an established connection is terminated,
 220          * the OnDisconnect method is triggered.
 221          */
 222         virtual int OnDisconnect();
 223
 224         /**
 225          * When there is data waiting to be read on a
 226          * socket, the OnDataReady() method is called.
 227          * Within this method, you *MUST* call the Read()
 228          * method to read any pending data. At its lowest
 229          * level, this event is signalled by the core via
 230          * the socket engine. If you return false from this
 231          * function, the core removes your socket from its
 232          * list and erases it from the socket engine, then
 233          * calls BufferedSocket::Close() and deletes it.
 234          * @return false to close the socket
 235          */
 236         virtual bool OnDataReady();
 237
 238         /**
 239          * When it is ok to write to the socket, and a
 240          * write event was requested, this method is
 241          * triggered.
 242          *
 243          * Within this method you should call
 244          * write() or send() etc, to send data to the
 245          * other end of the socket.
 246          *
 247          * Further write events will not be triggered
 248          * unless you call SocketEngine::WantWrite().
 249          *
 250          * The default behaviour of this method is to
 251          * flush the write buffer, respecting the IO
 252          * hooking modules.
 253          *
 254          * XXX: this used to be virtual, ask us if you need it to be so.
 255          * @return false to close the socket
 256          */
 257         bool OnWriteReady();
 258
 259         /**
 260          * When an outbound connection fails, and the
 261          * attempt times out, you will receive this event.
 262          * The method will trigger once maxtime seconds are
 263          * reached (as given in the constructor) just
 264          * before the socket's descriptor is closed.
 265          * A failed DNS lookup may cause this event if
 266          * the DNS server is not responding, as well as
 267          * a failed connect() call, because DNS lookups are
 268          * nonblocking as implemented by this class.
 269          */
 270         virtual void OnTimeout();
 271
 272         /**
 273          * Whenever close() is called, OnClose() will be
 274          * called first. Please note that this means
 275          * OnClose will be called alongside OnError(),
 276          * OnTimeout(), and Close().
 277          */
 278         virtual void OnClose();
 279
 280         /**
 281          * Reads all pending bytes from the socket
 282          * into a char* array which can be up to
 283          * 16 kilobytes in length.
 284          */
 285         virtual const char* Read();
 286
 287         /**
 288          * Returns the IP address associated with
 289          * this connection, or an empty string if
 290          * no IP address exists.
 291          */
 292         std::string GetIP();
 293
 294         /**
 295          * Writes a std::string to the socket. No carriage
 296          * returns or linefeeds are appended to the string.
 297          * @param data The data to send
 298          */
 299         virtual void Write(const std::string &data);
 300
 301         /**
 302          * Changes the socket's state. The core uses this
 303          * to change socket states, and you should not call
 304          * it directly.
 305          */
 306         void SetState(BufferedSocketState s);
 307
 308         /**
 309          * Returns the current socket state.
 310          */
 311         BufferedSocketState GetState();
 312
 313         /** Mark a socket as being connected and call appropriate events.
 314          */
 315         bool InternalMarkConnected();
 316
 317         /**
 318          * This method causes the socket to close, and may
 319          * also be triggered by other methods such as OnTimeout
 320          * and OnError.
 321          */
 322         virtual void Close();
 323
 324         /**
 325          * The destructor may implicitly call OnClose(), and
 326          * will close() and shutdown() the file descriptor
 327          * used for this socket.
 328          */
 329         virtual ~BufferedSocket();
 330
 331         /**
 332          * This method attempts to connect to a hostname.
 333          * This method is asyncronous.
 334          * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
 335          */
 336         virtual bool DoConnect(unsigned long maxtime);
 337
 338         /** Handle event from EventHandler parent class
 339          */
 340         void HandleEvent(EventType et, int errornum = 0);
 341
 342         /** Returns true if this socket is readable
 343          */
 344         bool Readable();
 345 };
 346
 347 #endif
 348