Create IOHook interface (extracted from Module)

1 files changed, 71 insertions, 0 deletions

diff --git a/include/iohook.h b/include/iohook.h
new file mode 100644
index 000000000..87403681d
--- /dev/null
+++ b/include/iohook.h
@@ -0,0 +1,71 @@
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   Copyright (C) 2013 Attila Molnar <attilamolnar@hush.com>
+ *
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+#pragma once
+
+class StreamSocket;
+
+class IOHook : public ServiceProvider
+{
+ public:
+	IOHook(Module* mod, const std::string& Name)
+		: ServiceProvider(mod, Name, SERVICE_IOHOOK) { }
+
+	/** Called immediately after any connection is accepted. This is intended for raw socket
+	 * processing (e.g. modules which wrap the tcp connection within another library) and provides
+	 * no information relating to a user record as the connection has not been assigned yet.
+	 * There are no return values from this call as all modules get an opportunity if required to
+	 * process the connection.
+	 * @param sock The socket in question
+	 * @param client The client IP address and port
+	 * @param server The server IP address and port
+	 */
+	virtual void OnStreamSocketAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) = 0;
+
+	/**
+	 * Called when a hooked stream has data to write, or when the socket
+	 * engine returns it as writable
+	 * @param sock The socket in question
+	 * @param sendq Data to send to the socket
+	 * @return 1 if the sendq has been completely emptied, 0 if there is
+	 *  still data to send, and -1 if there was an error
+	 */
+	virtual int OnStreamSocketWrite(StreamSocket* sock, std::string& sendq) = 0;
+
+	/** Called immediately before any socket is closed. When this event is called, shutdown()
+	 * has not yet been called on the socket.
+	 * @param sock The socket in question
+	 */
+	virtual void OnStreamSocketClose(StreamSocket* sock) = 0;
+
+	/** Called immediately upon connection of an outbound BufferedSocket which has been hooked
+	 * by a module.
+	 * @param sock The socket in question
+	 */
+	virtual void OnStreamSocketConnect(StreamSocket* sock) = 0;
+
+	/**
+	 * Called when the stream socket has data to read
+	 * @param sock The socket that is ready
+	 * @param recvq The receive queue that new data should be appended to
+	 * @return 1 if new data has been read, 0 if no new data is ready (but the
+	 *  socket is still connected), -1 if there was an error or close
+	 */
+	virtual int OnStreamSocketRead(StreamSocket* sock, std::string& recvq) = 0;
+};