openvpn::AppControlMessageConfig Struct Reference

#include <customcontrolchannel.hpp>

Public Member Functions
bool	operator== (const AppControlMessageConfig &other) const
void	parse_flags (const std::string &flags)
bool	supports_protocol (const std::string &protocol)
std::vector< std::string >	format_message (const std::string &protocol, const std::string &message)
	Format a protocol string and a message into a properly packed series of message fragments.
std::string	str () const

Public Attributes
bool	encoding_base64 = false
	Supports sending/receiving messages as base64 encoded binary.
bool	encoding_text = false
bool	encoding_binary = false
	support sending binary as is as part of the ACC control channel message (not implemented yet)
std::vector< std::string >	supported_protocols
	List of supported protocols.
int	max_msg_size = 0
	Maximum size of each individual message/message fragment.

Detailed Description

Definition at line 31 of file customcontrolchannel.hpp.

Member Function Documentation

format_message()

std::vector< std::string > openvpn::AppControlMessageConfig::format_message ( const std::string &  protocol, const std::string &  message  )

inline

Format a protocol string and a message into a properly packed series of message fragments.

Parameters

protocol	The requested ACC protocol
message	The raw message, which may be transformed during formatting

Returns

std::vector<std::string> The resulting container of message fragments

See also

AppControlMessageReceiver::receive_message

AppControlMessageReceiver::get_msg

Format a protocol string and a message into a properly packed series of message fragments. If the message is not a UTF-8 legal sequence, it will be encoded into some form that can represent the data in the message. Once it's received the AppControlMessageReceiver methods receive_message and get_msg can be used to reverse this process.

Definition at line 83 of file customcontrolchannel.hpp.

Here is the caller graph for this function:

operator==()

bool openvpn::AppControlMessageConfig::operator== ( const AppControlMessageConfig &  other ) const

inline

Definition at line 49 of file customcontrolchannel.hpp.

parse_flags()

void openvpn::AppControlMessageConfig::parse_flags ( const std::string &  flags )

inline

Definition at line 54 of file customcontrolchannel.hpp.

Here is the caller graph for this function:

str()

std::string openvpn::AppControlMessageConfig::str ( ) const

inline

Definition at line 137 of file customcontrolchannel.hpp.

Here is the caller graph for this function:

supports_protocol()

bool openvpn::AppControlMessageConfig::supports_protocol ( const std::string &  protocol )

inline

Definition at line 67 of file customcontrolchannel.hpp.

Here is the caller graph for this function:

Member Data Documentation

encoding_base64

bool openvpn::AppControlMessageConfig::encoding_base64 = false

Supports sending/receiving messages as base64 encoded binary.

Definition at line 34 of file customcontrolchannel.hpp.

encoding_binary

bool openvpn::AppControlMessageConfig::encoding_binary = false

support sending binary as is as part of the ACC control channel message (not implemented yet)

Definition at line 41 of file customcontrolchannel.hpp.

encoding_text

bool openvpn::AppControlMessageConfig::encoding_text = false

supports sending/receiving messages that are safe to be transmitted as text in an OpenVPN control message

Definition at line 38 of file customcontrolchannel.hpp.

max_msg_size

int openvpn::AppControlMessageConfig::max_msg_size = 0

Maximum size of each individual message/message fragment.

Definition at line 47 of file customcontrolchannel.hpp.

supported_protocols

std::vector<std::string> openvpn::AppControlMessageConfig::supported_protocols

List of supported protocols.

Definition at line 44 of file customcontrolchannel.hpp.

---

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

• openvpn/ssl/customcontrolchannel.hpp