#include <tuncli.hpp>

Inheritance diagram for openvpn::TunLinux::Client:

Collaboration diagram for openvpn::TunLinux::Client:

Public Member Functions
void	tun_start (const OptionList &opt, TransportClient &transcli, CryptoDCSettings &) override

bool	tun_send (BufferAllocated &buf) override

std::string	tun_name () const override

std::string	vpn_ip4 () const override

std::string	vpn_ip6 () const override

std::string	vpn_gw4 () const override

std::string	vpn_gw6 () const override

int	vpn_mtu () const override

void	set_disconnect () override

void	stop () override

virtual	~Client ()

void	apply_push_update (const OptionList &opt, TransportClient &transcli) override
	Notifies tun client about received PUSH_UPDATE control channel message.

Public Member Functions inherited from openvpn::TunClient
virtual void	adjust_mss (int mss)

virtual std::uint32_t	vpn_interface_index () const

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.

Private Types
using	TunImpl = Tun< Client * >

Private Member Functions
	Client (openvpn_io::io_context &io_context_arg, ClientConfig *config_arg, TunClientParent &parent_arg)

bool	send (Buffer &buf)

void	tun_read_handler (PacketFrom::SPtr &pfp)

void	tun_error_handler (const Error::Type errtype, const openvpn_io::error_code *error)

void	stop_ ()

Private Attributes
openvpn_io::io_context &	io_context

TunPersist::Ptr	tun_persist

ClientConfig::Ptr	config

TunClientParent &	parent

TunImpl::Ptr	impl

TunProp::State::Ptr	state

TunBuilderSetup::Base::Ptr	tun_setup

bool	halt

Friends
class	ClientConfig

class	TunIO< Client *, PacketFrom, openvpn_io::posix::stream_descriptor >

Additional Inherited Members
Public Types inherited from openvpn::TunClient
using	Ptr = RCPtr< TunClient >

Public Types inherited from openvpn::RC< thread_unsafe_refcount >
using	Ptr = RCPtr< RC >

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 123 of file tuncli.hpp.

Member Typedef Documentation

◆ TunImpl

using openvpn::TunLinux::Client::TunImpl = Tun<Client *>

private

Definition at line 128 of file tuncli.hpp.

Constructor & Destructor Documentation

◆ ~Client()

virtual openvpn::TunLinux::Client::~Client ( )

inlinevirtual

Definition at line 294 of file tuncli.hpp.

◆ Client()

openvpn::TunLinux::Client::Client	(	openvpn_io::io_context &	io_context_arg,
		ClientConfig *	config_arg,
		TunClientParent &	parent_arg
	)

inlineprivate

Definition at line 317 of file tuncli.hpp.

Member Function Documentation

◆ apply_push_update()

void openvpn::TunLinux::Client::apply_push_update	(	const OptionList &	opt,
		TransportClient &	cli
	)

inlineoverridevirtual

Notifies tun client about received PUSH_UPDATE control channel message.

The merging of exiting and incoming options (including removing options) happens before this call, so implementations are supposed to only undo existing options and apply the new ones, normally by calling stop() and tun_start().

Parameters

opt	merged options, to be applied by implementation
cli	transport client, passed to tun_start() call

Reimplemented from openvpn::TunClient.

Definition at line 299 of file tuncli.hpp.

◆ send()

bool openvpn::TunLinux::Client::send ( Buffer & buf )

inlineprivate

Definition at line 328 of file tuncli.hpp.

Here is the caller graph for this function:

◆ set_disconnect()

void openvpn::TunLinux::Client::set_disconnect ( )

inlineoverridevirtual

Implements openvpn::TunClient.

Definition at line 286 of file tuncli.hpp.

◆ stop()

void openvpn::TunLinux::Client::stop ( )

inlineoverridevirtual

Implements openvpn::TunClient.

Definition at line 290 of file tuncli.hpp.

Here is the caller graph for this function:

◆ stop_()

void openvpn::TunLinux::Client::stop_ ( )

inlineprivate

Definition at line 345 of file tuncli.hpp.

Here is the caller graph for this function:

◆ tun_error_handler()

void openvpn::TunLinux::Client::tun_error_handler	(	const Error::Type	errtype,
		const openvpn_io::error_code *	error
	)

inlineprivate

Definition at line 340 of file tuncli.hpp.

◆ tun_name()

std::string openvpn::TunLinux::Client::tun_name ( ) const

inlineoverridevirtual

Implements openvpn::TunClient.

Definition at line 246 of file tuncli.hpp.

◆ tun_read_handler()

void openvpn::TunLinux::Client::tun_read_handler ( PacketFrom::SPtr & pfp )

inlineprivate

Definition at line 335 of file tuncli.hpp.

◆ tun_send()

bool openvpn::TunLinux::Client::tun_send ( BufferAllocated & buf )

inlineoverridevirtual

Implements openvpn::TunClient.

Definition at line 241 of file tuncli.hpp.

◆ tun_start()

void openvpn::TunLinux::Client::tun_start	(	const OptionList &	opt,
		TransportClient &	transcli,
		CryptoDCSettings &
	)

inlineoverridevirtual

Implements openvpn::TunClient.

Definition at line 131 of file tuncli.hpp.

◆ vpn_gw4()

std::string openvpn::TunLinux::Client::vpn_gw4 ( ) const

inlineoverridevirtual

Reimplemented from openvpn::TunClient.

Definition at line 267 of file tuncli.hpp.

◆ vpn_gw6()

std::string openvpn::TunLinux::Client::vpn_gw6 ( ) const

inlineoverridevirtual

Reimplemented from openvpn::TunClient.

Definition at line 274 of file tuncli.hpp.

◆ vpn_ip4()

std::string openvpn::TunLinux::Client::vpn_ip4 ( ) const

inlineoverridevirtual

Implements openvpn::TunClient.

Definition at line 253 of file tuncli.hpp.

◆ vpn_ip6()

std::string openvpn::TunLinux::Client::vpn_ip6 ( ) const

inlineoverridevirtual

Implements openvpn::TunClient.

Definition at line 260 of file tuncli.hpp.

◆ vpn_mtu()

int openvpn::TunLinux::Client::vpn_mtu ( ) const

inlineoverridevirtual

Implements openvpn::TunClient.

Definition at line 281 of file tuncli.hpp.

Friends And Related Symbol Documentation

◆ ClientConfig

friend class ClientConfig

friend

Definition at line 125 of file tuncli.hpp.

◆ TunIO< Client *, PacketFrom, openvpn_io::posix::stream_descriptor >

friend class TunIO< Client *, PacketFrom, openvpn_io::posix::stream_descriptor >

friend

Definition at line 125 of file tuncli.hpp.

Member Data Documentation

◆ config

ClientConfig::Ptr openvpn::TunLinux::Client::config

private

Definition at line 361 of file tuncli.hpp.

◆ halt

bool openvpn::TunLinux::Client::halt

private

Definition at line 366 of file tuncli.hpp.

◆ impl

TunImpl::Ptr openvpn::TunLinux::Client::impl

private

Definition at line 363 of file tuncli.hpp.

◆ io_context

openvpn_io::io_context& openvpn::TunLinux::Client::io_context

private

Definition at line 359 of file tuncli.hpp.

◆ parent

TunClientParent& openvpn::TunLinux::Client::parent

private

Definition at line 362 of file tuncli.hpp.

◆ state

TunProp::State::Ptr openvpn::TunLinux::Client::state

private

Definition at line 364 of file tuncli.hpp.

◆ tun_persist

TunPersist::Ptr openvpn::TunLinux::Client::tun_persist

private

Definition at line 360 of file tuncli.hpp.

◆ tun_setup

TunBuilderSetup::Base::Ptr openvpn::TunLinux::Client::tun_setup

private

Definition at line 365 of file tuncli.hpp.

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

openvpn/tun/linux/client/tuncli.hpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TunImpl

Constructor & Destructor Documentation

◆ ~Client()

◆ Client()

Member Function Documentation

◆ apply_push_update()

◆ send()

◆ set_disconnect()

◆ stop()

◆ stop_()

◆ tun_error_handler()

◆ tun_name()

◆ tun_read_handler()

◆ tun_send()

◆ tun_start()

◆ vpn_gw4()

◆ vpn_gw6()

◆ vpn_ip4()

◆ vpn_ip6()

◆ vpn_mtu()

Friends And Related Symbol Documentation

◆ ClientConfig

◆ TunIO< Client *, PacketFrom, openvpn_io::posix::stream_descriptor >

Member Data Documentation

◆ config

◆ halt

◆ impl

◆ io_context

◆ parent

◆ state

◆ tun_persist

◆ tun_setup