cosmos::InfoBase< DB_STRUCT > Class Template Reference

Base class for PasswdInfo and GroupInfo. More...

#include <InfoBase.hxx>

Public Member Functions
bool	valid () const
	Returns whether data is present in the object.
void	reset ()
	Zeroes out all data.
const DB_STRUCT *	raw () const
	Grants access to the raw underlying data structure.
DB_STRUCT *	raw ()

Protected Member Functions
bool	getInfo (std::function< int(DB_STRUCT **)> get_func, const char *errlabel)
	Helper to drive the common getter function logic for getpw* and getgr*.

Protected Attributes
bool	m_valid = false
DB_STRUCT	m_info
	struct passwd or struct group.
std::vector< char >	m_buf
	Extra space for storing the dynamic strings in the m_info struct.

Detailed Description

template<typename DB_STRUCT>
class cosmos::InfoBase< DB_STRUCT >

Base class for PasswdInfo and GroupInfo.

Definition at line 12 of file InfoBase.hxx.

Member Function Documentation

getInfo()

template<typename DB_STRUCT >

bool cosmos::InfoBase< DB_STRUCT >::getInfo ( std::function< int(DB_STRUCT **)> get_func, const char * errlabel )

protected

Helper to drive the common getter function logic for getpw* and getgr*.

Definition at line 17 of file InfoBase.hxx.

                                                                                              {
        DB_STRUCT *res;
        m_buf.resize(BUF_INIT_SIZE);
 
        while (true) {
                const auto err = get_func(&res);
                switch(Errno{err}) {
                        case Errno::NO_ERROR:
                                return res != nullptr;
                        case Errno::RANGE: m_buf.resize(m_buf.size() << 1); break;
                        default: cosmos_throw(ApiError(errlabel, Errno{err})); break;
                }
 
                if (m_buf.size() > BUF_MAX_SIZE) {
                        // don't get too crazy here
                        cosmos_throw(RuntimeError("buffer size limit reached"));
                }
        }
 
        return false;
}

raw() [1/2]

template<typename DB_STRUCT >

DB_STRUCT * cosmos::InfoBase< DB_STRUCT >::raw ( )

inline

Definition at line 27 of file InfoBase.hxx.

{ return &m_info; }

raw() [2/2]

template<typename DB_STRUCT >

const DB_STRUCT * cosmos::InfoBase< DB_STRUCT >::raw ( ) const

inline

Grants access to the raw underlying data structure.

Definition at line 26 of file InfoBase.hxx.

{ return &m_info; }

reset()

template<typename DB_STRUCT >

void cosmos::InfoBase< DB_STRUCT >::reset

(

)

Zeroes out all data.

Definition at line 40 of file InfoBase.hxx.

                                {
        m_buf.clear();
        zero_object(m_info);
        m_valid = false;
}

valid()

template<typename DB_STRUCT >

bool cosmos::InfoBase< DB_STRUCT >::valid ( ) const

inline

Returns whether data is present in the object.

If no corresponding entry was found during construction time then this returns false.

Definition at line 20 of file InfoBase.hxx.

{ return m_valid; }

Member Data Documentation

m_buf

template<typename DB_STRUCT >

std::vector<char> cosmos::InfoBase< DB_STRUCT >::m_buf

protected

Extra space for storing the dynamic strings in the m_info struct.

Definition at line 40 of file InfoBase.hxx.

m_info

template<typename DB_STRUCT >

DB_STRUCT cosmos::InfoBase< DB_STRUCT >::m_info

protected

struct passwd or struct group.

Definition at line 38 of file InfoBase.hxx.

m_valid

template<typename DB_STRUCT >

bool cosmos::InfoBase< DB_STRUCT >::m_valid = false

protected

Definition at line 36 of file InfoBase.hxx.

---

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

• include/InfoBase.hxx
• src/cosmos/private/InfoBase.hxx