From 097b2479d0393d8a8bada4a50708d7a2404045ca Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 12 Dec 2005 13:32:15 +0000 Subject: Added new docs for class SocketEngine git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2339 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/socketengine_8h.html | 218 +++++++++++++++++++++++++++++++++++ 1 file changed, 218 insertions(+) create mode 100644 docs/module-doc/socketengine_8h.html (limited to 'docs/module-doc/socketengine_8h.html') diff --git a/docs/module-doc/socketengine_8h.html b/docs/module-doc/socketengine_8h.html new file mode 100644 index 000000000..f91808a45 --- /dev/null +++ b/docs/module-doc/socketengine_8h.html @@ -0,0 +1,218 @@ + + +InspIRCd: socketengine.h File Reference + + + +

+home » brain » inspircd-cvs » inspircd » include

socketengine.h File Reference

#include <vector>
+#include <string>
+#include "inspircd_config.h"
+#include "globals.h"
+#include "inspircd.h"
+#include <sys/types.h>
+#include <sys/event.h>
+#include <sys/time.h>
+ +

+Include dependency graph for socketengine.h:

+ +

+This graph shows which files directly or indirectly include this file:

+ + + + + + +

+Go to the source code of this file. + + + + + + + + + + + + + + + + + + + + +

Classes
class SocketEngine
The actual socketengine class presents the same interface on all operating systems, but its private members and internal behaviour should be treated as blackboxed, and vary from system to system and upon the config settings chosen by the server admin. More...

Variables
const char X_EMPTY_SLOT = 0
Each of these values represents a socket type in our reference table (the reference table itself is only accessible to socketengine.cpp).
const char X_LISTEN = 1
const char X_ESTAB_CLIENT = 2
const char X_ESTAB_MODULE = 3
const char X_ESTAB_DNS = 4
const char X_READBIT = 0x80
To indicate that a socket is readable, we mask its top bit with this X_READBIT value.
+

Variable Documentation

+ + + + +
+ + + + +
const char X_EMPTY_SLOT = 0
+
+ + + + + +
+ + + +
+Each of these values represents a socket type in our reference table (the reference table itself is only accessible to socketengine.cpp). +
+ +
+Definition at line 41 of file socketengine.h. +
+Referenced by SocketEngine::GetType().
+

+ + + + +
+ + + + +
const char X_ESTAB_CLIENT = 2
+
+ + + + + +
+ + + +
+ +
+Definition at line 43 of file socketengine.h.
+

+ + + + +
+ + + + +
const char X_ESTAB_DNS = 4
+
+ + + + + +
+ + + +
+ +
+Definition at line 45 of file socketengine.h.
+

+ + + + +
+ + + + +
const char X_ESTAB_MODULE = 3
+
+ + + + + +
+ + + +
+ +
+Definition at line 44 of file socketengine.h. +
+Referenced by InspSocket::InspSocket(), and InspSocket::Poll().
+

+ + + + +
+ + + + +
const char X_LISTEN = 1
+
+ + + + + +
+ + + +
+ +
+Definition at line 42 of file socketengine.h.
+

+ + + + +
+ + + + +
const char X_READBIT = 0x80
+
+ + + + + +
+ + + +
+To indicate that a socket is readable, we mask its top bit with this X_READBIT value. +
+The socket engine can handle two types of socket, readable and writeable (error sockets are dealt with when read() and write() return negative or zero values). +
+Definition at line 55 of file socketengine.h. +
+Referenced by SocketEngine::AddFd(), SocketEngine::DelFd(), and SocketEngine::Wait().
+

Generated on Mon Dec 12 13:31:11 2005 for InspIRCd by + +

1.4.4-20050815

+ + -- cgit v1.3.1-10-gc9f91


Classes
class	SocketEngine
	The actual socketengine class presents the same interface on all operating systems, but its private members and internal behaviour should be treated as blackboxed, and vary from system to system and upon the config settings chosen by the server admin. More...
Variables
const char	X_EMPTY_SLOT = 0
	Each of these values represents a socket type in our reference table (the reference table itself is only accessible to socketengine.cpp).
const char	X_LISTEN = 1
const char	X_ESTAB_CLIENT = 2
const char	X_ESTAB_MODULE = 3
const char	X_ESTAB_DNS = 4
const char	X_READBIT = 0x80
	To indicate that a socket is readable, we mask its top bit with this X_READBIT value.