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