X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fsocketengine.h;h=f647f4df3add6d6c6b440ed64848ff7070054833;hb=001861f5d2aca21531b0a20a46e44654a45a5522;hp=46a267fb1e79740b3318da8ad80f4c342e25aeb1;hpb=d0d36795e807cf72295c6e73813e0c2daa0a71e7;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/socketengine.h b/include/socketengine.h
index 46a267fb1..f647f4df3 100644
--- a/include/socketengine.h
+++ b/include/socketengine.h
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
@@ -69,6 +69,7 @@ class CoreExport EventHandler : public Extensible
 	 */
 	int fd;
  public:
+
 	/** Get the current file descriptor
 	 * @return The file descriptor of this handler
 	 */
@@ -166,9 +167,16 @@ protected:
 	int CurrentSetSize;
 	/** Reference table, contains all current handlers
 	 */
-	EventHandler* ref[MAX_DESCRIPTORS];
+	EventHandler** ref;
+
+	int MAX_DESCRIPTORS;
 public:
 
+	double TotalEvents;
+	double ReadEvents;
+	double WriteEvents;
+	double ErrorEvents;
+
 	/** Constructor.
 	 * The constructor transparently initializes
 	 * the socket engine which the ircd is using.
@@ -278,36 +286,115 @@ public:
 	 */
 	virtual bool BoundsCheckFd(EventHandler* eh);
 
+	/** Abstraction for BSD sockets accept(2).
+	 * This function should emulate its namesake system call exactly.
+	 * @param fd This version of the call takes an EventHandler instead of a bare file descriptor.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int Accept(EventHandler* fd, sockaddr *addr, socklen_t *addrlen);
 
+	/** Abstraction for BSD sockets close(2).
+	 * This function should emulate its namesake system call exactly.
+	 * @param fd This version of the call takes an EventHandler instead of a bare file descriptor.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int Close(EventHandler* fd);
 
+	/** Abstraction for BSD sockets close(2).
+	 * This function should emulate its namesake system call exactly.
+	 * This function should emulate its namesake system call exactly.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int Close(int fd);
 
+	/** Abstraction for BSD sockets send(2).
+	 * This function should emulate its namesake system call exactly.
+	 * @param fd This version of the call takes an EventHandler instead of a bare file descriptor.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int Send(EventHandler* fd, const void *buf, size_t len, int flags);
 
+	/** Abstraction for BSD sockets recv(2).
+	 * This function should emulate its namesake system call exactly.
+	 * @param fd This version of the call takes an EventHandler instead of a bare file descriptor.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int Recv(EventHandler* fd, void *buf, size_t len, int flags);
 
+	/** Abstraction for BSD sockets recvfrom(2).
+	 * This function should emulate its namesake system call exactly.
+	 * @param fd This version of the call takes an EventHandler instead of a bare file descriptor.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int RecvFrom(EventHandler* fd, void *buf, size_t len, int flags, sockaddr *from, socklen_t *fromlen);
 
+	/** Abstraction for BSD sockets sendto(2).
+	 * This function should emulate its namesake system call exactly.
+	 * @param fd This version of the call takes an EventHandler instead of a bare file descriptor.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int SendTo(EventHandler* fd, const void *buf, size_t len, int flags, const sockaddr *to, socklen_t tolen);
 
+	/** Abstraction for BSD sockets connect(2).
+	 * This function should emulate its namesake system call exactly.
+	 * @param fd This version of the call takes an EventHandler instead of a bare file descriptor.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int Connect(EventHandler* fd, const sockaddr *serv_addr, socklen_t addrlen);
 
+	/** Make a file descriptor blocking.
+	 * @param fd a file descriptor to set to blocking mode
+	 * @return 0 on success, -1 on failure, errno is set appropriately.
+	 */
 	virtual int Blocking(int fd);
 
+	/** Make a file descriptor nonblocking.
+	 * @param fd A file descriptor to set to nonblocking mode
+	 * @return 0 on success, -1 on failure, errno is set appropriately.
+	 */
 	virtual int NonBlocking(int fd);
 
+	/** Abstraction for BSD sockets shutdown(2).
+	 * This function should emulate its namesake system call exactly.
+	 * @param fd This version of the call takes an EventHandler instead of a bare file descriptor.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int Shutdown(EventHandler* fd, int how);
 
+	/** Abstraction for BSD sockets shutdown(2).
+	 * This function should emulate its namesake system call exactly.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int Shutdown(int fd, int how);
 
+	/** Abstraction for BSD sockets bind(2).
+	 * This function should emulate its namesake system call exactly.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int Bind(int fd, const sockaddr *my_addr, socklen_t addrlen);
 
+	/** Abstraction for BSD sockets listen(2).
+	 * This function should emulate its namesake system call exactly.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int Listen(int sockfd, int backlog);
 
+	/** Abstraction for BSD sockets getsockname(2).
+	 * This function should emulate its namesake system call exactly.
+	 * @param fd This version of the call takes an EventHandler instead of a bare file descriptor.
+	 * @return This method should return exactly the same values as the system call it emulates.
+	 */
 	virtual int GetSockName(EventHandler* fd, sockaddr *name, socklen_t* namelen);
 
+	/** This function is called immediately after fork().
+	 * Some socket engines (notably kqueue) cannot have their
+	 * handles inherited by forked processes. This method
+	 * allows for the socket engine to re-create its handle
+	 * after the daemon forks as the socket engine is created
+	 * long BEFORE the daemon forks.
+	 * @return void, but it is acceptable for this function to bail back to
+	 * the shell or operating system on fatal error.
+	 */
 	virtual void RecoverFromFork();
 };