1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
17 #ifndef __SOCKETENGINE__
18 #define __SOCKETENGINE__
23 #include "inspircd_config.h"
28 * Each of these values represents a socket
29 * type in our reference table (the reference
30 * table itself is only accessible to
33 const char X_EMPTY_SLOT = 0;
34 const char X_LISTEN = 1;
35 const char X_ESTAB_CLIENT = 2;
36 const char X_ESTAB_MODULE = 3;
37 const char X_ESTAB_DNS = 4;
40 * To indicate that a socket is readable, we
41 * mask its top bit with this X_READBIT value.
42 * The socket engine can handle two types of
43 * socket, readable and writeable (;error sockets
44 * are dealt with when read() and write() return
45 * negative or zero values).
47 const char X_READBIT = 0x80;
50 * The actual socketengine class presents the
51 * same interface on all operating systems, but
52 * its private members and internal behaviour
53 * should be treated as blackboxed, and vary
54 * from system to system and upon the config
55 * settings chosen by the server admin. The current
56 * version supports select, epoll and kqueue.
57 * The configure script will enable a socket engine
58 * based upon what OS is detected, and will derive
59 * a class from SocketEngine based upon what it finds.
60 * The derived classes file will also implement a
61 * classfactory, SocketEngineFactory, which will
62 * create a derived instance of SocketEngine using
63 * polymorphism so that the core and modules do not
64 * have to be aware of which SocketEngine derived
65 * class they are using.
67 class SocketEngine : public Extensible
70 int EngineHandle; /* Handle to the socket engine if needed */
71 int CurrentSetSize; /* Current number of descriptors in the engine */
72 char ref[MAX_DESCRIPTORS]; /* Reference table */
76 * The constructor transparently initializes
77 * the socket engine which the ircd is using.
78 * Please note that if there is a catastrophic
79 * failure (for example, you try and enable
80 * epoll on a 2.4 linux kernel) then this
81 * function may bail back to the shell.
86 * The destructor transparently tidies up
87 * any resources used by the socket engine.
89 virtual ~SocketEngine();
91 /** Add a file descriptor to the engine
92 * Use AddFd to add a file descriptor to the
93 * engine and have the socket engine monitor
94 * it. You must provide a type (see the consts
95 * in socketengine.h) and a boolean flag to
96 * indicate wether to watch this fd for read
97 * or write events (there is currently no
98 * need for support of both).
100 virtual bool AddFd(int fd, bool readable, char type);
102 /** Returns the type value for this file descriptor
103 * This function masks off the X_READBIT value
104 * so that the type of the socket can be obtained.
105 * The core uses this to decide where to dispatch
106 * the event to. Please note that some engines
107 * such as select() have an upper limit of 1024
108 * descriptors which may be active at any one time,
109 * where others such as kqueue have no practical
112 char GetType(int fd);
114 /** Returns the maximum number of file descriptors
115 * you may store in the socket engine at any one time.
117 virtual int GetMaxFds();
119 /** Returns the number of file descriptor slots
120 * which are available for storing fds.
122 virtual int GetRemainingFds();
124 /** Delete a file descriptor from the engine
125 * This function call deletes a file descriptor
126 * from the engine, returning true if it succeeded
127 * and false if it failed.
129 virtual bool DelFd(int fd);
131 /** Returns true if a socket exists in the socket
136 /** Waits for an event.
137 * Please note that this doesnt wait long, only
138 * a couple of milliseconds. It returns a list
139 * of active file descriptors in the vector
140 * fdlist which the core may then act upon.
142 virtual int Wait(int* fdlist);
144 /** Returns the socket engines name
145 * This returns the name of the engine for use
146 * in /VERSION responses.
148 virtual std::string GetName();