include/inspsocket.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 <sstream>
  21 #include <string>
  22 #include <deque>
  23 #include "inspircd_config.h"
  24 #include "dns.h"
  25 #include "socket.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, I_ERR_WRITE };
  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 protected:
  51
  52         std::deque<std::string> outbuffer;
  53
  54         /**
  55          * The file descriptor of this socket
  56          */
  57         int fd;
  58
  59         /**
  60          * The resolver for this socket
  61          */
  62         DNS dns;
  63
  64         /**
  65          * The hostname connected to
  66          */
  67         char host[MAXBUF];
  68
  69         /**
  70          * The port connected to, or the port
  71          * this socket is listening on
  72          */
  73         int port;
  74
  75         /**
  76          * The state for this socket, either
  77          * listening, connecting, connected
  78          * or error.
  79          */
  80         InspSocketState state;
  81
  82         /**
  83          * The host being connected to,
  84          * in sockaddr form
  85          */
  86         insp_sockaddr addr;
  87
  88         /**
  89          * The host being connected to,
  90          * in in_addr form
  91          */
  92         insp_inaddr addy;
  93
  94         /**
  95          * When this time is reached,
  96          * the socket times out if it is
  97          * in the CONNECTING state
  98          */
  99         time_t timeout_end;
 100
 101         /**
 102          * This value is true if the
 103          * socket has timed out.
 104          */
 105         bool timeout;
 106
 107         /**
 108          * Socket input buffer, used by read(). The class which
 109          * extends InspSocket is expected to implement an extendable
 110          * buffer which can grow much larger than 64k,
 111          * this buffer is just designed to be temporary storage.
 112          * space.
 113          */
 114         char ibuf[65535];
 115
 116         /**
 117          * The IP address being connected
 118          * to stored in string form for
 119          * easy retrieval by accessors.
 120          */
 121         char IP[MAXBUF];
 122
 123         /**
 124          * Client sockaddr structure used
 125          * by accept()
 126          */
 127         insp_sockaddr client;
 128
 129         /**
 130          * Server sockaddr structure used
 131          * by accept()
 132          */
 133         insp_sockaddr server;
 134
 135         /**
 136          * Used by accept() to indicate the
 137          * sizes of the sockaddr_in structures
 138          */
 139         socklen_t length;
 140
 141         /** Flushes the write buffer
 142          */
 143         bool FlushWriteBuffer();
 144
 145         /** Set the queue sizes
 146          * This private method sets the operating system queue
 147          * sizes for this socket to 65535 so that it can queue
 148          * more information without application-level queueing
 149          * which was required in older software.
 150          */
 151         void SetQueues(int nfd);
 152
 153         /** When the socket has been marked as closing, this flag
 154          * will be set to true, then the next time the socket is
 155          * examined, the socket is deleted and closed.
 156          */
 157         bool ClosePending;
 158
 159         /** Set to true when we're waiting for a write event.
 160          * If this is true and a write event comes in, we
 161          * call the write instead of the read method.
 162          */
 163         bool WaitingForWriteEvent;
 164
 165         bool BindAddr();
 166
 167 public:
 168
 169         /**
 170          * The default constructor does nothing
 171          * and should not be used.
 172          */
 173         InspSocket();
 174
 175         /**
 176          * This constructor is used to associate
 177          * an existing connecting with an InspSocket
 178          * class. The given file descriptor must be
 179          * valid, and when initialized, the InspSocket
 180          * will be set with the given IP address
 181          * and placed in CONNECTED state.
 182          */
 183         InspSocket(int newfd, const char* ip);
 184
 185         /**
 186          * This constructor is used to create a new
 187          * socket, either listening for connections, or an outbound connection to another host.
 188          * Note that if you specify a hostname in the 'host' parameter, then there will be an extra
 189          * step involved (a nonblocking DNS lookup) which will cause your connection to be established
 190          * slower than if it was an IP. Therefore, use an IP address where it is available instead.
 191          * @param host The hostname to connect to, or bind to
 192          * @param port The port number to connect to, or bind to
 193          * @param listening true to listen on the given host:port pair, or false to connect to them
 194          * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
 195          */
 196         InspSocket(const std::string &host, int port, bool listening, unsigned long maxtime);
 197
 198         /**
 199          * This method is called when an outbound
 200          * connection on your socket is completed.
 201          * @return false to abort the connection, true to continue
 202          */
 203         virtual bool OnConnected();
 204
 205         /**
 206          * This method is called when an error occurs.
 207          * A closed socket in itself is not an error,
 208          * however errors also generate close events.
 209          * @param e The error type which occured
 210          */
 211         virtual void OnError(InspSocketError e);
 212
 213         /**
 214          * When an established connection is terminated,
 215          * the OnDisconnect method is triggered.
 216          */
 217         virtual int OnDisconnect();
 218
 219         /**
 220          * When there is data waiting to be read on a
 221          * socket, the OnDataReady() method is called.
 222          * Within this method, you *MUST* call the Read()
 223          * method to read any pending data. At its lowest
 224          * level, this event is signalled by the core via
 225          * the socket engine. If you return false from this
 226          * function, the core removes your socket from its
 227          * list and erases it from the socket engine, then
 228          * calls InspSocket::Close() and deletes it.
 229          * @return false to close the socket
 230          */
 231         virtual bool OnDataReady();
 232
 233         virtual bool OnWriteReady();
 234
 235         /**
 236          * When an outbound connection fails, and the
 237          * attempt times out, you will receive this event.
 238          * The method will trigger once maxtime seconds are
 239          * reached (as given in the constructor) just
 240          * before the socket's descriptor is closed.
 241          * A failed DNS lookup may cause this event if
 242          * the DNS server is not responding, as well as
 243          * a failed connect() call, because DNS lookups are
 244          * nonblocking as implemented by this class.
 245          */
 246         virtual void OnTimeout();
 247
 248         /**
 249          * Whenever close() is called, OnClose() will be
 250          * called first. Please note that this means
 251          * OnClose will be called alongside OnError(),
 252          * OnTimeout(), and Close(), and also when
 253          * cancelling a listening socket by calling
 254          * the destructor indirectly.
 255          */
 256         virtual void OnClose();
 257
 258         /**
 259          * Reads all pending bytes from the socket
 260          * into a char* array which can be up to
 261          * 16 kilobytes in length.
 262          */
 263         virtual char* Read();
 264
 265         /**
 266          * Returns the IP address associated with
 267          * this connection, or an empty string if
 268          * no IP address exists.
 269          */
 270         std::string GetIP();
 271
 272         /**
 273          * This function checks if the socket has
 274          * timed out yet, given the current time
 275          * in the parameter.
 276          * @return true if timed out, false if not timed out
 277          */
 278         bool Timeout(time_t current);
 279
 280         /**
 281          * Writes a std::string to the socket. No carriage
 282          * returns or linefeeds are appended to the string.
 283          * @param data The data to send
 284          */
 285         virtual int Write(const std::string &data);
 286
 287         /**
 288          * If your socket is a listening socket, when a new
 289          * connection comes in on the socket this method will
 290          * be called. Given the new file descriptor in the
 291          * parameters, and the IP, it is recommended you copy
 292          * them to a new instance of your socket class,
 293          * e.g.:
 294          *
 295          * MySocket* newsocket = new MySocket(newfd,ip);
 296          *
 297          * Once you have done this, you can then associate the
 298          * new socket with the core using Server::AddSocket().
 299          */
 300         virtual int OnIncomingConnection(int newfd, char* ip);
 301
 302         /**
 303          * Changes the socket's state. The core uses this
 304          * to change socket states, and you should not call
 305          * it directly.
 306          */
 307         void SetState(InspSocketState s);
 308
 309         /**
 310          * Call this to receive the next write event
 311          * that comes along for this fd to the OnWriteReady
 312          * method.
 313          */
 314         void WantWrite();
 315
 316         /**
 317          * Returns the current socket state.
 318          */
 319         InspSocketState GetState();
 320
 321         /**
 322          * Only the core should call this function.
 323          * When called, it is assumed the socket is ready
 324          * to read data, and the method call routes the
 325          * event to the various methods of InspSocket
 326          * for you to handle. This can also cause the
 327          * socket's state to change.
 328          */
 329         bool Poll();
 330
 331         /**
 332          * This method returns the socket's file descriptor
 333          * as assigned by the operating system, or -1
 334          * if no descriptor has been assigned.
 335          */
 336         int GetFd();
 337
 338         /**
 339          * This method causes the socket to close, and may
 340          * also be triggered by other methods such as OnTimeout
 341          * and OnError.
 342          */
 343         virtual void Close();
 344
 345         /**
 346          * The destructor may implicitly call OnClose(), and
 347          * will close() and shutdown() the file descriptor
 348          * used for this socket.
 349          */
 350         virtual ~InspSocket();
 351
 352         /**
 353          * This method attempts to resolve the hostname,
 354          * if a hostname is given and not an IP,
 355          * before a connection can occur. This method is
 356          * asyncronous.
 357          */
 358         virtual bool DoResolve();
 359
 360         /**
 361          * This method attempts to connect to a hostname.
 362          * This only occurs on a non-listening socket. This
 363          * method is asyncronous.
 364          */
 365         virtual bool DoConnect();
 366
 367         /**
 368          * This method marks the socket closed.
 369          * The next time the core examines a socket marked
 370          * as closed, the socket will be closed and the
 371          * memory reclaimed.
 372          */
 373         void MarkAsClosed();
 374 };
 375
 376 #endif