BazisLib::Network::Filters::_DummyNetworkFilter Class Reference

This class is intended to ensure correct virtual member declaration in platform-specific base. More...

#include <filter.h>

Inherits BazisLib::Win32::NetworkFilterBase.

Collaboration diagram for BazisLib::Network::Filters::_DummyNetworkFilter:

Collaboration graph
[legend]

List of all members.

Protected Member Functions

virtual BazisLib::ActionStatus OnStartConnect (BazisLib::Network::_PlatformSpecificInternetAddress *pAddr, void **ppUserContext)
 Called when a connection attempt is intercepted.
virtual void OnDisconnect (void *pSystemContext, void *pUserContext) override=0
 Called when a socket is freed (connection is dropped).
virtual size_t OnSend (void *pSystemContext, void *pSystemContext2, void *pBuf, size_t MaxSize, void *pUserContext, bool ForceBlockingMode) override=0
virtual size_t OnReceive (void *pSystemContext, void *pSystemContext2, void *pBuf, size_t MaxSize, void *pUserContext, bool ForceBlockingMode) override=0
virtual void FreeUserContext (void *pContext) override=0


Detailed Description

This class is intended to ensure correct virtual member declaration in platform-specific base.

This class is not directly used and is implemented only to provide compiler-level check for correct member declaration in platform-specific base class. Additionally, the comments for the filtering methods are located in this class.


Member Function Documentation

virtual void BazisLib::Network::Filters::_DummyNetworkFilter::FreeUserContext ( void *  pContext  )  [override, protected, pure virtual]

virtual void BazisLib::Network::Filters::_DummyNetworkFilter::OnDisconnect ( void *  pSystemContext,
void *  pUserContext 
) [override, protected, pure virtual]

Called when a socket is freed (connection is dropped).

This method is called when a filtered program terminates an existing connection.

Attention:
Note that you should NOT free the pUserContext from this method. Implement all freeing functionality in FreeUserContext() instead.

Reimplemented from BazisLib::Win32::NetworkFilterBase.

virtual size_t BazisLib::Network::Filters::_DummyNetworkFilter::OnReceive ( void *  pSystemContext,
void *  pSystemContext2,
void *  pBuf,
size_t  MaxSize,
void *  pUserContext,
bool  ForceBlockingMode 
) [override, protected, pure virtual]

virtual size_t BazisLib::Network::Filters::_DummyNetworkFilter::OnSend ( void *  pSystemContext,
void *  pSystemContext2,
void *  pBuf,
size_t  MaxSize,
void *  pUserContext,
bool  ForceBlockingMode 
) [override, protected, pure virtual]

virtual BazisLib::ActionStatus BazisLib::Network::Filters::_DummyNetworkFilter::OnStartConnect ( BazisLib::Network::_PlatformSpecificInternetAddress pAddr,
void **  ppUserContext 
) [protected, virtual]

Called when a connection attempt is intercepted.

This method is called when a filtered program tries to create an outgoing connection. As connection attempts may be asynchronous, the real connection is established after this method returns a successful status.

Parameters:
pAddr Specifies the destination address
pSystemContext Specifies the system context that should be used in calls to __super::OnConnect().
ppUserContext Is always non-null. User can set this pointer to a user-provided context value that will be passed to other filtering functions when the current socket will be used. Note that if you allocate some memory to create a user context, you should override the FreeUserContext() member to provide freeing function. The FreeUserContext() member will be then called automatically.
Returns:
If the connection can be established, the function should return a successful status. If not - an error.
Attention:
Note that this method can omit a call to __super::OnStartConnect().

Reimplemented from BazisLib::Win32::NetworkFilterBase.


The documentation for this class was generated from the following file:
SourceForge.net Logo