OpenVPN 3 Core Library
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
openvpn::WS::Creds Struct Reference

#include <httpcreds.hpp>

Public Member Functions

 OPENVPN_EXCEPTION (web_creds_error)
 
bool defined () const
 
bool defined_full () const
 
void save_to_file (const std::string &fn) const
 
bool operator== (const Creds &rhs) const
 
bool operator!= (const Creds &rhs) const
 
bool password_eq (const Creds &rhs) const
 
std::string to_string () const
 

Static Public Member Functions

static Creds load_from_header (const HTTP::HeaderList &headlist, const bool password_required, const bool throw_on_error)
 
static Creds load_from_file (const std::string &fn, const bool password_required, const bool throw_on_error)
 
static Creds load_from_options (const OptionList &opt, const std::string &opt_name, const unsigned int flags)
 

Public Attributes

std::string username
 
std::string password
 

Detailed Description

Definition at line 31 of file httpcreds.hpp.

Member Function Documentation

◆ defined()

bool openvpn::WS::Creds::defined ( ) const
inline

Definition at line 113 of file httpcreds.hpp.

◆ defined_full()

bool openvpn::WS::Creds::defined_full ( ) const
inline

Definition at line 118 of file httpcreds.hpp.

◆ load_from_file()

static Creds openvpn::WS::Creds::load_from_file ( const std::string &  fn,
const bool  password_required,
const bool  throw_on_error 
)
inlinestatic

Definition at line 75 of file httpcreds.hpp.

◆ load_from_header()

static Creds openvpn::WS::Creds::load_from_header ( const HTTP::HeaderList &  headlist,
const bool  password_required,
const bool  throw_on_error 
)
inlinestatic

Definition at line 35 of file httpcreds.hpp.

◆ load_from_options()

static Creds openvpn::WS::Creds::load_from_options ( const OptionList &  opt,
const std::string &  opt_name,
const unsigned int  flags 
)
inlinestatic

Definition at line 104 of file httpcreds.hpp.

◆ OPENVPN_EXCEPTION()

openvpn::WS::Creds::OPENVPN_EXCEPTION ( web_creds_error  )

◆ operator!=()

bool openvpn::WS::Creds::operator!= ( const Creds &  rhs) const
inline

Definition at line 133 of file httpcreds.hpp.

Here is the caller graph for this function:

◆ operator==()

bool openvpn::WS::Creds::operator== ( const Creds &  rhs) const
inline

Definition at line 128 of file httpcreds.hpp.

◆ password_eq()

bool openvpn::WS::Creds::password_eq ( const Creds &  rhs) const
inline

Definition at line 142 of file httpcreds.hpp.

◆ save_to_file()

void openvpn::WS::Creds::save_to_file ( const std::string &  fn) const
inline

Definition at line 123 of file httpcreds.hpp.

◆ to_string()

std::string openvpn::WS::Creds::to_string ( ) const
inline

Definition at line 149 of file httpcreds.hpp.

Member Data Documentation

◆ password

std::string openvpn::WS::Creds::password

Definition at line 155 of file httpcreds.hpp.

◆ username

std::string openvpn::WS::Creds::username

Definition at line 154 of file httpcreds.hpp.

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