pion::user Class Reference

#include <user.hpp>

Inheritance diagram for pion::user:

Collaboration diagram for pion::user:

Public Member Functions
	user (std::string const &username)
	construct a new user object More...
	user (std::string const &username, std::string const &password)
	construct a new user object More...
virtual	~user ()
	virtual destructor More...
std::string const &	get_username () const
	returns user name as a string More...
std::string const &	get_password () const
	returns password for the user (encrypted if SSL is enabled) More...
virtual bool	match_password (const std::string &password) const
virtual void	set_password (const std::string &password)
	sets password credentials for given user More...

Protected Attributes
const std::string	m_username
	username string More...
std::string	m_password
	password string (actual contents depends on implementation) More...

Detailed Description

user: base class to store user credentials

Constructor & Destructor Documentation

pion::user::user ( std::string const &  username )

inline

construct a new user object

pion::user::user ( std::string const &  username, std::string const &  password  )

inline

construct a new user object

References set_password().

virtual pion::user::~user ( )

inlinevirtual

virtual destructor

Member Function Documentation

std::string const& pion::user::get_password ( ) const

inline

returns password for the user (encrypted if SSL is enabled)

References m_password.

std::string const& pion::user::get_username ( ) const

inline

returns user name as a string

References m_username.

virtual bool pion::user::match_password ( const std::string &  password ) const

inlinevirtual

matches password credential for given user

Parameters

password

password credentials

References m_password.

virtual void pion::user::set_password ( const std::string &  password )

inlinevirtual

sets password credentials for given user

References m_password.

Referenced by user().

Member Data Documentation

std::string pion::user::m_password

protected

password string (actual contents depends on implementation)

Referenced by get_password(), match_password(), and set_password().

const std::string pion::user::m_username

protected

username string

Referenced by get_username().

---

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

• include/pion/user.hpp