1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * Inspire is copyright (C) 2002-2005 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"
27 #include <sys/epoll.h>
31 #include <sys/types.h>
32 #include <sys/event.h>
37 * Each of these values represents a socket
38 * type in our reference table (the reference
39 * table itself is only accessible to
42 const char X_EMPTY_SLOT = 0;
43 const char X_LISTEN = 1;
44 const char X_ESTAB_CLIENT = 2;
45 const char X_ESTAB_MODULE = 3;
46 const char X_ESTAB_DNS = 4;
49 * To indicate that a socket is readable, we
50 * mask its top bit with this X_READBIT value.
51 * The socket engine can handle two types of
52 * socket, readable and writeable (error sockets
53 * are dealt with when read() and write() return
54 * negative or zero values).
56 const char X_READBIT = 0x80;
59 * The actual socketengine class presents the
60 * same interface on all operating systems, but
61 * its private members and internal behaviour
62 * should be treated as blackboxed, and vary
63 * from system to system and upon the config
64 * settings chosen by the server admin. The current
65 * version supports select, epoll and kqueue.
69 int EngineHandle; /* Handle to the socket engine if needed */
71 std::map<int,int> fds; /* List of file descriptors being monitored */
72 fd_set wfdset, rfdset; /* Readable and writeable sets for select() */
75 struct kevent ke_list[65535]; /* Up to 64k sockets for kqueue */
76 struct timespec ts; /* kqueue delay value */
79 struct epoll_event events[65535]; /* Up to 64k sockets for epoll */
85 * The constructor transparently initializes
86 * the socket engine which the ircd is using.
87 * Please note that if there is a catastrophic
88 * failure (for example, you try and enable
89 * epoll on a 2.4 linux kernel) then this
90 * function may bail back to the shell.
95 * The destructor transparently tidies up
96 * any resources used by the socket engine.
100 /** Add a file descriptor to the engine
101 * Use AddFd to add a file descriptor to the
102 * engine and have the socket engine monitor
103 * it. You must provide a type (see the consts
104 * in socketengine.h) and a boolean flag to
105 * indicate wether to watch this fd for read
106 * or write events (there is currently no
107 * need for support of both).
109 bool AddFd(int fd, bool readable, char type);
111 /** Returns the type value for this file descriptor
112 * This function masks off the X_READBIT value
113 * so that the type of the socket can be obtained.
114 * The core uses this to decide where to dispatch
115 * the event to. Please note that some engines
116 * such as select() have an upper limit of 1024
117 * descriptors which may be active at any one time,
118 * where others such as kqueue have no practical
121 char GetType(int fd);
123 /** Delete a file descriptor f rom the engine
124 * This function call deletes a file descriptor
125 * from the engine, returning true if it succeeded
126 * and false if it failed.
130 /** Waits for an event.
131 * Please note that this doesnt wait long, only
132 * a couple of milliseconds. It returns a list
133 * of active file descriptors in the vector
134 * fdlist which the core may then act upon.
136 int Wait(int* fdlist);
138 /** Returns the socket engines name
139 * This returns the name of the engine for use
140 * in /VERSION responses.
142 std::string GetName();