OpenVPN 3 Core Library
Loading...
Searching...
No Matches
openvpn::TunBuilderClient::Tun< ReadHandler > Class Template Reference

#include <client.hpp>

Inheritance diagram for openvpn::TunBuilderClient::Tun< ReadHandler >:
[legend]
Collaboration diagram for openvpn::TunBuilderClient::Tun< ReadHandler >:
[legend]

Public Types

typedef RCPtr< TunPtr
 
- Public Types inherited from openvpn::TunIO< ReadHandler, PacketFrom, openvpn_io::posix::stream_descriptor >
typedef RCPtr< TunIOPtr
 
- Public Types inherited from openvpn::RC< thread_unsafe_refcount >
typedef RCPtr< RCPtr
 

Public Member Functions

 Tun (openvpn_io::io_context &io_context, const int socket, const bool retain_sd_arg, const bool tun_prefix_arg, ReadHandler read_handler_arg, const Frame::Ptr &frame_arg, const SessionStats::Ptr &stats_arg)
 
 ~Tun ()
 
- Public Member Functions inherited from openvpn::TunIO< ReadHandler, PacketFrom, openvpn_io::posix::stream_descriptor >
 TunIO (ReadHandler read_handler_arg, const Frame::Ptr &frame_arg, const SessionStats::Ptr &stats_arg, const size_t frame_context_type=Frame::READ_TUN)
 
 TunIO (ReadHandler read_handler_arg, const Frame::Context &frame_context_arg, const SessionStats::Ptr &stats_arg)
 
virtual ~TunIO ()
 
bool write (Buffer &buf)
 
bool write_seq (const BUFSEQ &bs)
 
void start (const int n_parallel)
 
void stop ()
 
std::string name () const
 
- Public Member Functions inherited from openvpn::RC< thread_unsafe_refcount >
 RC () noexcept=default
 
 RC (const RC &)=delete
 
virtual ~RC ()=default
 
RCoperator= (const RC &)=delete
 
olong use_count () const noexcept
 Delegates call to RCImpl and returns the result.
 

Private Types

typedef TunIO< ReadHandler, PacketFrom, openvpn_io::posix::stream_descriptor > Base
 

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.
 
- Protected Member Functions inherited from openvpn::TunIO< ReadHandler, PacketFrom, openvpn_io::posix::stream_descriptor >
void queue_read (PacketFrom *tunfrom)
 
void handle_read (typename PacketFrom::SPtr pfp, const openvpn_io::error_code &error, const size_t bytes_recvd)
 
void tun_error (const Error::Type errtype, const openvpn_io::error_code *error)
 
- Protected Attributes inherited from openvpn::TunIO< ReadHandler, PacketFrom, openvpn_io::posix::stream_descriptor >
std::string name_
 
openvpn_io::posix::stream_descriptor * stream
 
bool retain_stream
 
bool tun_prefix
 
ReadHandler read_handler
 
const Frame::Context frame_context
 
SessionStats::Ptr stats
 
bool halt
 

Detailed Description

template<typename ReadHandler>
class openvpn::TunBuilderClient::Tun< ReadHandler >

Definition at line 43 of file client.hpp.

Member Typedef Documentation

◆ Base

template<typename ReadHandler >
typedef TunIO<ReadHandler, PacketFrom, openvpn_io::posix::stream_descriptor> openvpn::TunBuilderClient::Tun< ReadHandler >::Base
private

Definition at line 45 of file client.hpp.

◆ Ptr

template<typename ReadHandler >
typedef RCPtr<Tun> openvpn::TunBuilderClient::Tun< ReadHandler >::Ptr

Definition at line 48 of file client.hpp.

Constructor & Destructor Documentation

◆ Tun()

template<typename ReadHandler >
openvpn::TunBuilderClient::Tun< ReadHandler >::Tun ( openvpn_io::io_context &  io_context,
const int  socket,
const bool  retain_sd_arg,
const bool  tun_prefix_arg,
ReadHandler  read_handler_arg,
const Frame::Ptr frame_arg,
const SessionStats::Ptr stats_arg 
)
inline

Definition at line 50 of file client.hpp.

◆ ~Tun()

template<typename ReadHandler >
openvpn::TunBuilderClient::Tun< ReadHandler >::~Tun ( )
inline

Definition at line 65 of file client.hpp.


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