mirror of
https://github.com/inspircd/inspircd.git
synced 2025-03-10 02:59:01 -04:00
99f79a4e5c
Create one IOHook instance for each hooked socket which contains all the hook specific data and read/write/close functions, removing the need for the "issl_session" array in SSL modules. Register instances of the IOHookProvider class in the core and use them to create specialized IOHook instances (OnConnect/OnAccept). Remove the OnHookIO hook, add a dynamic reference to ListenSocket that points to the hook provider (if any) to use for incoming connections on that socket. For outgoing connections modules still have to find the IOHookProvider they want to use themselves but instead of calling AddIOHook(hookprov), now they have to call IOHookProvider::OnConnect() after the connection has been established.
90 lines
3.0 KiB
C++
90 lines
3.0 KiB
C++
/*
|
|
* 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 IOHookProvider : public ServiceProvider
|
|
{
|
|
public:
|
|
enum Type
|
|
{
|
|
IOH_UNKNOWN,
|
|
IOH_SSL
|
|
};
|
|
|
|
const Type type;
|
|
|
|
IOHookProvider(Module* mod, const std::string& Name, Type hooktype = IOH_UNKNOWN)
|
|
: ServiceProvider(mod, Name, SERVICE_IOHOOK), type(hooktype) { }
|
|
|
|
/** Called immediately after a 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.
|
|
* @param sock The socket in question
|
|
* @param client The client IP address and port
|
|
* @param server The server IP address and port
|
|
*/
|
|
virtual void OnAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) = 0;
|
|
|
|
/** Called immediately upon connection of an outbound BufferedSocket which has been hooked
|
|
* by a module.
|
|
* @param sock The socket in question
|
|
*/
|
|
virtual void OnConnect(StreamSocket* sock) = 0;
|
|
};
|
|
|
|
class IOHook : public classbase
|
|
{
|
|
public:
|
|
/** The IOHookProvider for this hook, contains information about the hook,
|
|
* such as the module providing it and the hook type.
|
|
*/
|
|
IOHookProvider* const prov;
|
|
|
|
IOHook(IOHookProvider* provider)
|
|
: prov(provider) { }
|
|
|
|
/**
|
|
* 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 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;
|
|
};
|