PionNetworkLibrary
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
pion::admin_rights Class Reference

#include <admin_rights.hpp>

Public Member Functions

 admin_rights (bool use_log=true)
 
virtual ~admin_rights ()
 destructor releases administrative rights More...
 
void release (void)
 releases administrative rights More...
 

Static Public Member Functions

static long run_as_user (const std::string &user_name)
 calculates the user id based upon the user configuration parameter More...
 
static long run_as_group (const std::string &group_name)
 calculates the group id based upon the group configuration parameter More...
 

Detailed Description

admin_rights: obtains administrative rights for the process

Constructor & Destructor Documentation

pion::admin_rights::admin_rights ( bool  use_log = true)

constructs object, obtaining administrative rights; will block if another thread has already obtained rights

Parameters
use_logif false, then no logging will be performed

References PION_LOG_DEBUG, and PION_LOG_ERROR.

virtual pion::admin_rights::~admin_rights ( )
inlinevirtual

destructor releases administrative rights

Member Function Documentation

void pion::admin_rights::release ( void  )

releases administrative rights

References PION_LOG_DEBUG, and PION_LOG_ERROR.

long pion::admin_rights::run_as_group ( const std::string &  group_name)
static

calculates the group id based upon the group configuration parameter

long pion::admin_rights::run_as_user ( const std::string &  user_name)
static

calculates the user id based upon the user configuration parameter


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