Inheritance diagram for IOHook:

Public Member Functions
	IOHook (IOHookProvider *provider)

virtual int	OnStreamSocketWrite (StreamSocket *sock, StreamSocket::SendQueue &sendq)=0

virtual void	OnStreamSocketClose (StreamSocket *sock)=0

virtual int	OnStreamSocketRead (StreamSocket *sock, std::string &recvq)=0

Public Member Functions inherited from classbase
virtual CullResult	cull ()

Constructor & Destructor Documentation

◆ IOHook()

IOHook::IOHook ( IOHookProvider * provider )

inline

Constructor

Parameters

provider IOHookProvider that creates this object

virtual void IOHook::OnStreamSocketClose ( StreamSocket * sock )

pure virtual

Called immediately before the hooked socket is closed. When this event is called, shutdown() has not yet been called on the socket.

Parameters

sock	Hooked socket

virtual int IOHook::OnStreamSocketRead	(	StreamSocket *	sock,
		std::string &	recvq
	)

pure virtual

Called when the hooked socket has data to read

Parameters

sock	Hooked socket
recvq	The receive queue that new data should be appended to

Returns: 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 IOHook::OnStreamSocketWrite	(	StreamSocket *	sock,
		StreamSocket::SendQueue &	sendq
	)

pure virtual

Called when the hooked socket has data to write, or when the socket engine returns it as writable

Parameters

sock	Hooked socket
sendq	Send queue to send data from

Returns: 1 if the sendq has been completely emptied, 0 if there is still data to send, and -1 if there was an error

The IOHookProvider for this hook, contains information about the hook, such as the module providing it and the hook type.

The documentation for this class was generated from the following file: