include/socket.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #ifndef __INSP_SOCKET_H__
  18 #define __INSP_SOCKET_H__
  19
  20 #include <sys/types.h>
  21 #include <sys/socket.h>
  22 #include <netinet/in.h>
  23 #include <sstream>
  24 #include <string>
  25 #include "dns.h"
  26
  27 /**
  28  * States which a socket may be in
  29  */
  30 enum InspSocketState { I_DISCONNECTED, I_RESOLVING, I_CONNECTING, I_CONNECTED, I_LISTENING, I_ERROR };
  31
  32 /**
  33  * Error types which a socket may exhibit
  34  */
  35 enum InspSocketError { I_ERR_TIMEOUT, I_ERR_SOCKET, I_ERR_CONNECT, I_ERR_BIND, I_ERR_RESOLVE };
  36
  37 /**
  38  * InspSocket is an extendable socket class which modules
  39  * can use for TCP socket support. It is fully integrated
  40  * into InspIRCds socket loop and attaches its sockets to
  41  * the core's instance of the SocketEngine class, meaning
  42  * that any sockets you create have the same power and
  43  * abilities as a socket created by the core itself.
  44  * To use InspSocket, you must inherit a class from it,
  45  * and use the InspSocket constructors to establish connections
  46  * and bindings.
  47  */
  48 class InspSocket
  49 {
  50 private:
  51
  52         /**
  53          * The file descriptor of this socket
  54          */
  55         int fd;
  56
  57         /**
  58          * The resolver for this socket
  59          */
  60         DNS dns;
  61
  62         /**
  63          * The hostname connected to
  64          */
  65         std::string host;
  66
  67         /**
  68          * The port connected to, or the port
  69          * this socket is listening on
  70          */
  71         int port;
  72
  73         /**
  74          * The state for this socket, either
  75          * listening, connecting, connected
  76          * or error.
  77          */
  78         InspSocketState state;
  79
  80         /**
  81          * The host being connected to,
  82          * in sockaddr form
  83          */
  84         sockaddr_in addr;
  85
  86         /**
  87          * The host being connected to,
  88          * in in_addr form
  89          */
  90         in_addr addy;
  91
  92         /**
  93          * When this time is reached,
  94          * the socket times out if it is
  95          * in the CONNECTING state
  96          */
  97         time_t timeout_end;
  98
  99         /**
 100          * This value is true if the
 101          * socket has timed out.
 102          */
 103         bool timeout;
 104
 105         /**
 106          * Socket input buffer, used by read(). The class which
 107          * extends InspSocket is expected to implement an extendable
 108          * buffer which can grow much larger than 64k,
 109          * this buffer is just designed to be temporary storage.
 110          * space.
 111          */
 112         char ibuf[65535];
 113
 114         /**
 115          * The output buffer for this socket
 116          */
 117         std::string Buffer;
 118
 119         /**
 120          * The IP address being connected
 121          * to stored in string form for
 122          * easy retrieval by accessors.
 123          */
 124         std::string IP;
 125
 126         /**
 127          * Client sockaddr structure used
 128          * by accept()
 129          */
 130         sockaddr_in client;
 131
 132         /**
 133          * Server sockaddr structure used
 134          * by accept()
 135          */
 136         sockaddr_in server;
 137
 138         /**
 139          * Used by accept() to indicate the
 140          * sizes of the sockaddr_in structures
 141          */
 142         socklen_t length;
 143
 144         /** Flushes the write buffer
 145          */
 146         void FlushWriteBuffer();
 147
 148         void SetQueues(int nfd);
 149
 150 public:
 151
 152         /**
 153          * The default constructor does nothing
 154          * and should not be used.
 155          */
 156         InspSocket();
 157
 158         /**
 159          * This constructor is used to associate
 160          * an existing connecting with an InspSocket
 161          * class. The given file descriptor must be
 162          * valid, and when initialized, the InspSocket
 163          * will be set with the given IP address
 164          * and placed in CONNECTED state.
 165          */
 166         InspSocket(int newfd, char* ip);
 167
 168         /**
 169          * This constructor is used to create a new
 170          * socket, either listening for connections, or an outbound connection to another host.
 171          * Note that if you specify a hostname in the 'host' parameter, then there will be an extra
 172          * step involved (a nonblocking DNS lookup) which will cause your connection to be established
 173          * slower than if it was an IP. Therefore, use an IP address where it is available instead.
 174          * @param host The hostname to connect to, or bind to
 175          * @param port The port number to connect to, or bind to
 176          * @param listening true to listen on the given host:port pair, or false to connect to them
 177          * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
 178          */
 179         InspSocket(std::string host, int port, bool listening, unsigned long maxtime);
 180
 181         /**
 182          * This method is called when an outbound
 183          * connection on your socket is completed.
 184          * @return false to abort the connection, true to continue
 185          */
 186         virtual bool OnConnected();
 187
 188         /**
 189          * This method is called when an error occurs.
 190          * A closed socket in itself is not an error,
 191          * however errors also generate close events.
 192          * @param e The error type which occured
 193          */
 194         virtual void OnError(InspSocketError e);
 195
 196         /**
 197          * When an established connection is terminated,
 198          * the OnDisconnect method is triggered.
 199          */
 200         virtual int OnDisconnect();
 201
 202         /**
 203          * When there is data waiting to be read on a
 204          * socket, the OnDataReady() method is called.
 205          * Within this method, you *MUST* call the Read()
 206          * method to read any pending data. At its lowest
 207          * level, this event is signalled by the core via
 208          * the socket engine. If you return false from this
 209          * function, the core removes your socket from its
 210          * list and erases it from the socket engine, then
 211          * calls InspSocket::Close() and deletes it.
 212          * @return false to close the socket
 213          */
 214         virtual bool OnDataReady();
 215
 216         /**
 217          * When an outbound connection fails, and the
 218          * attempt times out, you will receive this event.
 219          * The method will trigger once maxtime seconds are
 220          * reached (as given in the constructor) just
 221          * before the socket's descriptor is closed.
 222          * A failed DNS lookup may cause this event if
 223          * the DNS server is not responding, as well as
 224          * a failed connect() call, because DNS lookups are
 225          * nonblocking as implemented by this class.
 226          */
 227         virtual void OnTimeout();
 228
 229         /**
 230          * Whenever close() is called, OnClose() will be
 231          * called first. Please note that this means
 232          * OnClose will be called alongside OnError(),
 233          * OnTimeout(), and Close(), and also when
 234          * cancelling a listening socket by calling
 235          * the destructor indirectly.
 236          */
 237         virtual void OnClose();
 238
 239         /**
 240          * Reads all pending bytes from the socket
 241          * into a char* array which can be up to
 242          * 16 kilobytes in length.
 243          */
 244         virtual char* Read();
 245
 246         /**
 247          * Returns the IP address associated with
 248          * this connection, or an empty string if
 249          * no IP address exists.
 250          */
 251         std::string GetIP();
 252
 253         /**
 254          * This function checks if the socket has
 255          * timed out yet, given the current time
 256          * in the parameter.
 257          * @return true if timed out, false if not timed out
 258          */
 259         bool Timeout(time_t current);
 260
 261         /**
 262          * Writes a std::string to the socket. No carriage
 263          * returns or linefeeds are appended to the string.
 264          * @param data The data to send
 265          */
 266         virtual int Write(std::string data);
 267
 268         /**
 269          * If your socket is a listening socket, when a new
 270          * connection comes in on the socket this method will
 271          * be called. Given the new file descriptor in the
 272          * parameters, and the IP, it is recommended you copy
 273          * them to a new instance of your socket class,
 274          * e.g.:
 275          *
 276          * MySocket* newsocket = new MySocket(newfd,ip);
 277          *
 278          * Once you have done this, you can then associate the
 279          * new socket with the core using Server::AddSocket().
 280          */
 281         virtual int OnIncomingConnection(int newfd, char* ip);
 282
 283         /**
 284          * Changes the socket's state. The core uses this
 285          * to change socket states, and you should not call
 286          * it directly.
 287          */
 288         void SetState(InspSocketState s);
 289
 290         /**
 291          * Returns the current socket state.
 292          */
 293         InspSocketState GetState();
 294
 295         /**
 296          * Only the core should call this function.
 297          * When called, it is assumed the socket is ready
 298          * to read data, and the method call routes the
 299          * event to the various methods of InspSocket
 300          * for you to handle. This can also cause the
 301          * socket's state to change.
 302          */
 303         bool Poll();
 304
 305         /**
 306          * This method returns the socket's file descriptor
 307          * as assigned by the operating system, or -1
 308          * if no descriptor has been assigned.
 309          */
 310         int GetFd();
 311
 312         /**
 313          * This method causes the socket to close, and may
 314          * also be triggered by other methods such as OnTimeout
 315          * and OnError.
 316          */
 317         virtual void Close();
 318
 319         /**
 320          * The destructor may implicitly call OnClose(), and
 321          * will close() and shutdown() the file descriptor
 322          * used for this socket.
 323          */
 324         virtual ~InspSocket();
 325
 326         virtual bool DoResolve();
 327         virtual bool DoConnect();
 328 };
 329
 330 #endif