OpenVPN 3 Core Library
Loading...
Searching...
No Matches
openvpn::TunWin::WFP::EngineHandle Class Reference

Public Member Functions

 EngineHandle ()
 Open a new WFP session and store the handle.
 
void reset (std::ostream *log)
 Close the engine handle.
 
 ~EngineHandle ()
 
bool defined () const
 
HANDLE operator() () const
 Return the engine handle.
 

Private Member Functions

 EngineHandle (const EngineHandle &)=delete
 
EngineHandleoperator= (const EngineHandle &)=delete
 

Private Attributes

HANDLE handle = INVALID_HANDLE_VALUE
 

Detailed Description

Definition at line 439 of file wfp.hpp.

Constructor & Destructor Documentation

◆ EngineHandle() [1/2]

openvpn::TunWin::WFP::EngineHandle::EngineHandle ( )
inline

Open a new WFP session and store the handle.

Definition at line 445 of file wfp.hpp.

◆ ~EngineHandle()

openvpn::TunWin::WFP::EngineHandle::~EngineHandle ( )
inline

Definition at line 480 of file wfp.hpp.

◆ EngineHandle() [2/2]

openvpn::TunWin::WFP::EngineHandle::EngineHandle ( const EngineHandle )
privatedelete

Member Function Documentation

◆ defined()

bool openvpn::TunWin::WFP::EngineHandle::defined ( ) const
inline

Definition at line 485 of file wfp.hpp.

Here is the caller graph for this function:

◆ operator()()

HANDLE openvpn::TunWin::WFP::EngineHandle::operator() ( ) const
inline

Return the engine handle.

Returns
HANDLE The engine handle. May not represent an open session.

Definition at line 495 of file wfp.hpp.

◆ operator=()

EngineHandle & openvpn::TunWin::WFP::EngineHandle::operator= ( const EngineHandle )
privatedelete

◆ reset()

void openvpn::TunWin::WFP::EngineHandle::reset ( std::ostream *  log)
inline

Close the engine handle.

This will effectively remove all block filter rules set using this engine handle.

Parameters
logthe log ostream to use for disgnostics

Definition at line 464 of file wfp.hpp.

Here is the caller graph for this function:

Member Data Documentation

◆ handle

HANDLE openvpn::TunWin::WFP::EngineHandle::handle = INVALID_HANDLE_VALUE
private

Definition at line 504 of file wfp.hpp.


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