OpenVPN 3 Core Library
Loading...
Searching...
No Matches
openvpn::oob::ProbeParameter Struct Reference

probe parameter TLV (sent by the client in a SERVER_PROBE). More...

#include <oob_probe.hpp>

Public Member Functions

bool write (Buffer &buf) const
 Append this parameter as a complete TLV (header + value) to buf.
 

Static Public Member Functions

static std::optional< ProbeParameterread (Buffer &buf, std::uint16_t value_len)
 

Public Attributes

std::uint64_t timestamp = 0
 client clock as a UNIX timestamp
 
std::uint32_t flags = 0
 client capability flags, currently must be 0
 

Static Public Attributes

static constexpr std::size_t WIRE_LEN = 12
 

Detailed Description

probe parameter TLV (sent by the client in a SERVER_PROBE).

Definition at line 181 of file oob_probe.hpp.

Member Function Documentation

◆ read()

static std::optional< ProbeParameter > openvpn::oob::ProbeParameter::read ( Buffer buf,
std::uint16_t  value_len 
)
inlinestatic

Read a probe_parameter TLV value of value_len bytes from buf. The TLV header must already have been consumed. value_len bytes are consumed on success, including any trailing bytes beyond the fields understood here.

Definition at line 203 of file oob_probe.hpp.

Here is the caller graph for this function:

◆ write()

bool openvpn::oob::ProbeParameter::write ( Buffer buf) const
inline

Append this parameter as a complete TLV (header + value) to buf.

Definition at line 191 of file oob_probe.hpp.

Here is the caller graph for this function:

Member Data Documentation

◆ flags

std::uint32_t openvpn::oob::ProbeParameter::flags = 0

client capability flags, currently must be 0

Definition at line 188 of file oob_probe.hpp.

◆ timestamp

std::uint64_t openvpn::oob::ProbeParameter::timestamp = 0

client clock as a UNIX timestamp

Definition at line 187 of file oob_probe.hpp.

◆ WIRE_LEN

constexpr std::size_t openvpn::oob::ProbeParameter::WIRE_LEN = 12
staticconstexpr

minimum on-wire value length (u64 timestamp + u32 flags, excluding the 4-byte TLV header); may be longer on the wire for forward compatibility

Definition at line 185 of file oob_probe.hpp.


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