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

probe reply TLV (sent by the server in a PROBE_REPLY). More...

#include <oob_probe.hpp>

Collaboration diagram for openvpn::oob::ProbeReply:
[legend]

Public Member Functions

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

Static Public Member Functions

static std::optional< ProbeReplyread (Buffer &buf, std::uint16_t value_len)
 Read a probe_reply TLV value of value_len bytes; see ProbeParameter::read().
 

Public Attributes

ProtoSessionID peer_session_id
 echoes the session id of the request
 
std::uint16_t priority = 0
 DNS-SRV style priority (lower preferred)
 
std::uint16_t weight = 0
 DNS-SRV style weight.
 
std::uint16_t max_latency_diff = 0
 candidate-band margin (ms); 0 = client default
 
std::uint16_t connect_lifetime = 0
 seconds the reply is valid as a handshake shortcut
 
std::uint32_t flags = 0
 server behaviour flags (REPLY_FLAG_*)
 

Static Public Attributes

static constexpr std::size_t WIRE_LEN = 20
 

Detailed Description

probe reply TLV (sent by the server in a PROBE_REPLY).

Definition at line 217 of file oob_probe.hpp.

Member Function Documentation

◆ read()

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

Read a probe_reply TLV value of value_len bytes; see ProbeParameter::read().

Definition at line 246 of file oob_probe.hpp.

Here is the caller graph for this function:

◆ write()

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

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

Definition at line 231 of file oob_probe.hpp.

Here is the caller graph for this function:

Member Data Documentation

◆ connect_lifetime

std::uint16_t openvpn::oob::ProbeReply::connect_lifetime = 0

seconds the reply is valid as a handshake shortcut

Definition at line 227 of file oob_probe.hpp.

◆ flags

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

server behaviour flags (REPLY_FLAG_*)

Definition at line 228 of file oob_probe.hpp.

◆ max_latency_diff

std::uint16_t openvpn::oob::ProbeReply::max_latency_diff = 0

candidate-band margin (ms); 0 = client default

Definition at line 226 of file oob_probe.hpp.

◆ peer_session_id

ProtoSessionID openvpn::oob::ProbeReply::peer_session_id

echoes the session id of the request

Definition at line 223 of file oob_probe.hpp.

◆ priority

std::uint16_t openvpn::oob::ProbeReply::priority = 0

DNS-SRV style priority (lower preferred)

Definition at line 224 of file oob_probe.hpp.

◆ weight

std::uint16_t openvpn::oob::ProbeReply::weight = 0

DNS-SRV style weight.

Definition at line 225 of file oob_probe.hpp.

◆ WIRE_LEN

constexpr std::size_t openvpn::oob::ProbeReply::WIRE_LEN = 20
staticconstexpr

minimum on-wire value length (psid(8) + u16*4 + u32, excluding the 4-byte TLV header); may be longer on the wire for forward compatibility

Definition at line 221 of file oob_probe.hpp.


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