OpenVPN 3 Core Library
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
openvpn::TunWin::SetupBase Struct Referenceabstract

#include <setupbase.hpp>

Inheritance diagram for openvpn::TunWin::SetupBase:
[legend]
Collaboration diagram for openvpn::TunWin::SetupBase:
[legend]

Public Types

typedef RCPtr< SetupBase > Ptr
 
- Public Types inherited from openvpn::DestructorBase
typedef RCPtr< DestructorBase > Ptr
 
- Public Types inherited from openvpn::RC< thread_unsafe_refcount >
typedef RCPtr< RC > Ptr
 

Public Member Functions

 OPENVPN_EXCEPTION (tun_win_setup)
 
virtual HANDLE get_handle (std::ostream &os)=0
 
virtual HANDLE establish (const TunBuilderCapture &pull, const std::wstring &openvpn_app_path, Stop *stop, std::ostream &os, RingBuffer::Ptr rings)=0
 
virtual bool l2_ready (const TunBuilderCapture &pull)=0
 
virtual void l2_finish (const TunBuilderCapture &pull, Stop *stop, std::ostream &os)=0
 
virtual void confirm ()
 
virtual void set_service_fail_handler (std::function< void()> &&handler)
 
virtual Util::TapNameGuidPair get_adapter_state ()=0
 
virtual void set_adapter_state (const Util::TapNameGuidPair &state)=0
 
virtual DWORD vpn_interface_index () const
 
- Public Member Functions inherited from openvpn::DestructorBase
virtual void destroy (std::ostream &os)=0
 
virtual ~DestructorBase ()=default
 
- Public Member Functions inherited from openvpn::RC< thread_unsafe_refcount >
 RC () noexcept=default
 
 RC (const RC &)=delete
 
virtual ~RC ()=default
 
RC & operator= (const RC &)=delete
 
olong use_count () const noexcept
 Delegates call to RCImpl and returns the result.
 

Additional Inherited Members

- Static Public Member Functions inherited from openvpn::RC< thread_unsafe_refcount >
static constexpr bool is_thread_safe ()
 Delegates call to RCImpl and returns the result.
 

Detailed Description

Definition at line 32 of file setupbase.hpp.

Member Typedef Documentation

◆ Ptr

typedef RCPtr<SetupBase> openvpn::TunWin::SetupBase::Ptr

Definition at line 34 of file setupbase.hpp.

Member Function Documentation

◆ confirm()

virtual void openvpn::TunWin::SetupBase::confirm ( )
inlinevirtual

Reimplemented in openvpn::WinCommandAgent::SetupClient.

Definition at line 56 of file setupbase.hpp.

◆ establish()

virtual HANDLE openvpn::TunWin::SetupBase::establish ( const TunBuilderCapture &  pull,
const std::wstring &  openvpn_app_path,
Stop *  stop,
std::ostream &  os,
RingBuffer::Ptr  rings 
)
pure virtual

Implemented in openvpn::TunWin::Setup, and openvpn::WinCommandAgent::SetupClient.

◆ get_adapter_state()

virtual Util::TapNameGuidPair openvpn::TunWin::SetupBase::get_adapter_state ( )
pure virtual

Implemented in openvpn::WinCommandAgent::SetupClient, and openvpn::TunWin::Setup.

◆ get_handle()

virtual HANDLE openvpn::TunWin::SetupBase::get_handle ( std::ostream &  os)
pure virtual

Implemented in openvpn::WinCommandAgent::SetupClient, and openvpn::TunWin::Setup.

◆ l2_finish()

virtual void openvpn::TunWin::SetupBase::l2_finish ( const TunBuilderCapture &  pull,
Stop *  stop,
std::ostream &  os 
)
pure virtual

Implemented in openvpn::WinCommandAgent::SetupClient, and openvpn::TunWin::Setup.

◆ l2_ready()

virtual bool openvpn::TunWin::SetupBase::l2_ready ( const TunBuilderCapture &  pull)
pure virtual

Implemented in openvpn::WinCommandAgent::SetupClient, and openvpn::TunWin::Setup.

◆ OPENVPN_EXCEPTION()

openvpn::TunWin::SetupBase::OPENVPN_EXCEPTION ( tun_win_setup  )

◆ set_adapter_state()

virtual void openvpn::TunWin::SetupBase::set_adapter_state ( const Util::TapNameGuidPair &  state)
pure virtual

Implemented in openvpn::WinCommandAgent::SetupClient, and openvpn::TunWin::Setup.

◆ set_service_fail_handler()

virtual void openvpn::TunWin::SetupBase::set_service_fail_handler ( std::function< void()> &&  handler)
inlinevirtual

Reimplemented in openvpn::WinCommandAgent::SetupClient.

Definition at line 60 of file setupbase.hpp.

◆ vpn_interface_index()

virtual DWORD openvpn::TunWin::SetupBase::vpn_interface_index ( ) const
inlinevirtual

Reimplemented in openvpn::TunWin::Setup.

Definition at line 68 of file setupbase.hpp.

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