XrdCl::Env Class Reference

#include <XrdClEnv.hh>

Inheritance diagram for XrdCl::Env:

Collaboration diagram for XrdCl::Env:

Public Member Functions
virtual	~Env ()
	Destructor. More...
bool	DelInt (const std::string &key)
bool	DelString (const std::string &key)
bool	GetDefaultIntValue (const std::string &key, int &value)
bool	GetDefaultStringValue (const std::string &key, std::string &value)
bool	GetInt (const std::string &key, int &value)
bool	GetPtr (const std::string &key, void *&value)
bool	GetString (const std::string &key, std::string &value)
bool	ImportInt (const std::string &key, const std::string &shellKey)
bool	ImportString (const std::string &key, const std::string &shellKey)
bool	PutInt (const std::string &key, int value)
bool	PutPtr (const std::string &key, void *value)
bool	PutString (const std::string &key, const std::string &value)
void	RecreateLock ()
void	ReInitializeLock ()
void	UnLock ()
void	WriteLock ()

Detailed Description

A simple key value store intended to hold global configuration. It is able to import the settings from the shell environment, the variables imported this way supersede these provided from the C++ code.

Definition at line 37 of file XrdClEnv.hh.

Constructor & Destructor Documentation

~Env()

virtual XrdCl::Env::~Env ( )

inlinevirtual

Destructor.

Definition at line 43 of file XrdClEnv.hh.

{}

Member Function Documentation

DelInt()

bool XrdCl::Env::DelInt

(

const std::string &

key

)

Remove the int associated with the given key

Returns

false if there is a shell-imported setting for this key, true otherwise

Definition at line 174 of file XrdClEnv.cc.

  {
    std::string key = UnifyKey( k );
    XrdSysRWLockHelper scopedLock( pLock, false ); // obtain write lock
 
    IntMap::iterator it;
    it = pIntMap.find( key );
    if( it == pIntMap.end() )
      return true;
 
    Log *log = DefaultEnv::GetLog();
    if( it->second.second )
    {
      log->Debug( UtilityMsg,
                  "Env: trying to delete a shell-imported integer entry: %s",
                  key.c_str() );
      return false;
    }
    log->Debug( UtilityMsg, "Env: deleting integer entry: %s", key.c_str() );
    pIntMap.erase( it );
    return true;
  }

References XrdCl::Log::Debug(), XrdCl::DefaultEnv::GetLog(), and XrdCl::UtilityMsg.

Here is the call graph for this function:

DelString()

bool XrdCl::Env::DelString

(

const std::string &

key

)

Remove the string associated with the given key

Returns

false if there is a shell-imported setting for this key, true otherwise

Definition at line 89 of file XrdClEnv.cc.

  {
    std::string key = UnifyKey( k );
    XrdSysRWLockHelper scopedLock( pLock, false ); // obtain write lock
 
    StringMap::iterator it;
    it = pStringMap.find( key );
    if( it == pStringMap.end() )
      return true;
 
    Log *log = DefaultEnv::GetLog();
    if( it->second.second )
    {
      log->Debug( UtilityMsg,
                  "Env: trying to delete a shell-imported string entry: %s",
                  key.c_str() );
      return false;
    }
    log->Debug( UtilityMsg, "Env: deleting string entry: %s", key.c_str() );
    pStringMap.erase( it );
    return true;
  }

References XrdCl::Log::Debug(), XrdCl::DefaultEnv::GetLog(), and XrdCl::UtilityMsg.

Here is the call graph for this function:

GetDefaultIntValue()

bool XrdCl::Env::GetDefaultIntValue	(	const std::string &	key,
		int &	value
	)

Get default integer value for the given key

Parameters

key	: the key
value	: output parameter, default value corresponding to the key

Returns

: true if a default integer value for the given key exists, false otherwise

Definition at line 284 of file XrdClEnv.cc.

  {
    std::string key = UnifyKey( k );
    auto itr = theDefaultInts.find( key );
    if( itr == theDefaultInts.end() ) return false;
    value = itr->second;
    return true;
  }

References XrdCl::theDefaultInts.

GetDefaultStringValue()

bool XrdCl::Env::GetDefaultStringValue	(	const std::string &	key,
		std::string &	value
	)

Get default string value for the given key

Parameters

key	: the key
value	: output parameter, default value corresponding to the key

Returns

: true if a default string value for the given key exists, false otherwise

Definition at line 296 of file XrdClEnv.cc.

  {
    std::string key = UnifyKey( k );
    auto itr = theDefaultStrs.find( key );
    if( itr == theDefaultStrs.end() ) return false;
    value = itr->second;
    return true;
  }

References XrdCl::theDefaultStrs.

GetInt()

bool XrdCl::Env::GetInt	(	const std::string &	key,
		int &	value
	)

Get an int associated to the given key

Returns

true if the value was found, false otherwise

Definition at line 115 of file XrdClEnv.cc.

  {
    std::string key = UnifyKey( k );
    XrdSysRWLockHelper scopedLock( pLock );
    IntMap::iterator it;
    it = pIntMap.find( key );
    if( it == pIntMap.end() )
    {
      Log *log = DefaultEnv::GetLog();
      log->Debug( UtilityMsg,
                  "Env: trying to get a non-existent integer entry: %s",
                  key.c_str() );
      return false;
    }
    value = it->second.first;
    return true;
  }

References XrdCl::Log::Debug(), XrdCl::DefaultEnv::GetLog(), and XrdCl::UtilityMsg.

Referenced by XrdCl::AsyncSocketHandler::AsyncSocketHandler(), XrdCl::Channel::Channel(), XrdCl::PostMasterImpl::PostMasterImpl(), XrdCl::ZipListHandler::ZipListHandler(), XrdCl::CopyProcess::AddJob(), BuildPath(), child(), XrdCl::AsyncSocketHandler::Connect(), XrdClHttp::Factory::GetHeaderTimeoutWithDefault(), XrdCl::Utils::GetHostAddresses(), XrdCl::Utils::GetIntParameter(), XrdCl::Utils::InferChecksumType(), XrdCl::Socket::Initialize(), XrdCl::XRootDTransport::InitializeChannel(), XrdCl::InitTLS(), XrdCl::URL::IsMetalink(), XrdCl::XRootDTransport::IsStreamBroken(), XrdCl::XRootDTransport::IsStreamTTLElapsed(), main(), XrdCl::XRootDTransport::NeedEncryption(), parent(), XrdCl::FileStateHandler::PgWrite(), prepare(), XrdCl::XRootDMsgHandler::Process(), XrdCl::MessageUtils::ProcessSendParams(), XrdCl::MessageUtils::RewriteCGIAndPath(), XrdClHttp::CurlWorker::Run(), XrdCl::TickGeneratorTask::Run(), XrdCl::FileTimer::Run(), and XrdCl::XRootDTransport::SubStreamNumber().

Here is the call graph for this function:

Here is the caller graph for this function:

GetPtr()

bool XrdCl::Env::GetPtr	(	const std::string &	key,
		void *&	value
	)

Get a pointer associated to the given key

Returns

true if the value was found, false otherwise

Definition at line 200 of file XrdClEnv.cc.

  {
    std::string key = UnifyKey( k );
    XrdSysRWLockHelper scopedLock( pLock );
    PtrMap::iterator it;
    it = pPtrMap.find( key );
    if( it == pPtrMap.end() )
    {
      Log *log = DefaultEnv::GetLog();
      log->Debug( UtilityMsg,
                  "Env: trying to get a non-existent pointer entry: %s",
                  key.c_str() );
      return false;
    }
    value = it->second;
    return true;
  }

References XrdCl::Log::Debug(), XrdCl::DefaultEnv::GetLog(), and XrdCl::UtilityMsg.

Here is the call graph for this function:

GetString()

bool XrdCl::Env::GetString	(	const std::string &	key,
		std::string &	value
	)

Get a string associated to the given key

Returns

true if the value was found, false otherwise

Definition at line 31 of file XrdClEnv.cc.

  {
    std::string key = UnifyKey( k );
    XrdSysRWLockHelper scopedLock( pLock );
    StringMap::iterator it;
    it = pStringMap.find( key );
    if( it == pStringMap.end() )
    {
      Log *log = DefaultEnv::GetLog();
      log->Debug( UtilityMsg,
                  "Env: trying to get a non-existent string entry: %s",
                  key.c_str() );
      return false;
    }
    value = it->second.first;
    return true;
  }

References XrdCl::Log::Debug(), XrdCl::DefaultEnv::GetLog(), and XrdCl::UtilityMsg.

Referenced by BuildPath(), BuildPrompt(), DoCat(), DoLS(), DoTail(), XrdCl::DefaultEnv::GetMonitor(), XrdCl::Utils::GetStringParameter(), XrdCl::PostMaster::Initialize(), and XrdCl::PlugInManager::ProcessEnvironmentSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

ImportInt()

bool XrdCl::Env::ImportInt	(	const std::string &	key,
		const std::string &	shellKey
	)

Import an int from the shell environment. Any imported setting takes precedence over the one set by other means.

Returns

true if the setting exists in the shell, false otherwise

Definition at line 237 of file XrdClEnv.cc.

  {
    std::string key = UnifyKey( k );
    XrdSysRWLockHelper scopedLock( pLock, false );
    std::string strValue = GetEnv( shellKey );
    if( strValue == "" )
      return false;
 
    Log *log = DefaultEnv::GetLog();
    char *endPtr;
    int value = (int)strtol( strValue.c_str(), &endPtr, 0 );
    if( *endPtr )
    {
      log->Error( UtilityMsg,
                  "Env: Unable to import %s as %s: %s is not a proper integer",
                  shellKey.c_str(), key.c_str(), strValue.c_str() );
      return false;
    }
 
    log->Info( UtilityMsg, "Env: Importing from shell %s=%d as %s",
               shellKey.c_str(), value, key.c_str() );
 
    pIntMap[key] = std::make_pair( value, true );
    return true;
  }

References XrdCl::Log::Error(), XrdCl::DefaultEnv::GetLog(), XrdCl::Log::Info(), and XrdCl::UtilityMsg.

Here is the call graph for this function:

ImportString()

bool XrdCl::Env::ImportString	(	const std::string &	key,
		const std::string &	shellKey
	)

Import a string from the shell environment. Any imported setting takes precedence over the one set by ther means.

Returns

true if the setting exists in the shell, false otherwise

Definition at line 266 of file XrdClEnv.cc.

  {
    std::string key = UnifyKey( k );
    XrdSysRWLockHelper scopedLock( pLock, false );
    std::string value = GetEnv( shellKey );
    if( value == "" )
      return false;
 
    Log *log = DefaultEnv::GetLog();
    log->Info( UtilityMsg, "Env: Importing from shell %s=%s as %s",
               shellKey.c_str(), value.c_str(), key.c_str() );
    pStringMap[key] = std::make_pair( value, true );
    return true;
  }

References XrdCl::DefaultEnv::GetLog(), XrdCl::Log::Info(), and XrdCl::UtilityMsg.

Here is the call graph for this function:

PutInt()

bool XrdCl::Env::PutInt	(	const std::string &	key,
		int	value
	)

Associate an int with the given key

Returns

false if there is already a shell-imported setting for this key, true otherwise

Definition at line 136 of file XrdClEnv.cc.

  {
    std::string key = UnifyKey( k );
    XrdSysRWLockHelper scopedLock( pLock, false );
 
    //--------------------------------------------------------------------------
    // Insert the string if it's not there yet
    //--------------------------------------------------------------------------
    IntMap::iterator it;
    it = pIntMap.find( key );
    if( it == pIntMap.end() )
    {
      pIntMap[key] = std::make_pair( value, false );
      return true;
    }
 
    //--------------------------------------------------------------------------
    // The entry exists and it has been imported from the shell
    //--------------------------------------------------------------------------
    Log *log = DefaultEnv::GetLog();
    if( it->second.second )
    {
      log->Debug( UtilityMsg,
                  "Env: trying to override a shell-imported integer entry: %s",
                  key.c_str() );
      return false;
    }
    log->Debug( UtilityMsg,
                "Env: overriding entry: %s=%d with %d",
                key.c_str(), it->second.first, value );
 
    pIntMap[key] = std::make_pair( value, false );
    return true;
  }

References XrdCl::Log::Debug(), XrdCl::DefaultEnv::GetLog(), and XrdCl::UtilityMsg.

Referenced by DoCD(), DoLocate(), ExecuteCommand(), ExecuteInteractive(), XrdSsiClientProvider::GetService(), XrdCl::InitTLS(), main(), ProcessCommandLineEnv(), XrdPosixConfig::SetEnv(), and XrdSsiClientProvider::SetTimeout().

Here is the call graph for this function:

Here is the caller graph for this function:

PutPtr()

bool XrdCl::Env::PutPtr	(	const std::string &	key,
		void *	value
	)

Associate an int with the given key

Returns

true if the key was previously unset, false otherwise.

Definition at line 221 of file XrdClEnv.cc.

  {
    std::string key = UnifyKey( k );
    XrdSysRWLockHelper scopedLock( pLock, false );
 
    // Pointers cannot be imported from shell environment, we always set it.
    bool ret = pPtrMap.find(key) == pPtrMap.end();
 
    pPtrMap[key] = value;
 
    return ret;
  }

Referenced by XrdPosixConfig::SetEnv().

Here is the caller graph for this function:

PutString()

bool XrdCl::Env::PutString	(	const std::string &	key,
		const std::string &	value
	)

Associate a string with the given key

Returns

false if there is already a shell-imported setting for this key, true otherwise

Definition at line 52 of file XrdClEnv.cc.

  {
    std::string key = UnifyKey( k );
    XrdSysRWLockHelper scopedLock( pLock, false );
 
    //--------------------------------------------------------------------------
    // Insert the string if it's not there yet
    //--------------------------------------------------------------------------
    StringMap::iterator it;
    it = pStringMap.find( key );
    if( it == pStringMap.end() )
    {
      pStringMap[key] = std::make_pair( value, false );
      return true;
    }
 
    //--------------------------------------------------------------------------
    // The entry exists and it has been imported from the shell
    //--------------------------------------------------------------------------
    Log *log = DefaultEnv::GetLog();
    if( it->second.second )
    {
      log->Debug( UtilityMsg,
                  "Env: trying to override a shell-imported string entry: %s",
                  key.c_str() );
      return false;
    }
    log->Debug( UtilityMsg,
                "Env: overriding entry: %s=\"%s\" with \"%s\"",
                key.c_str(), it->second.first.c_str(), value.c_str() );
    pStringMap[key] = std::make_pair( value, false );
    return true;
  }

References XrdCl::Log::Debug(), XrdCl::DefaultEnv::GetLog(), and XrdCl::UtilityMsg.

Referenced by XrdCl::FSExecutor::FSExecutor(), CreateExecutor(), DoCD(), main(), and ProcessCommandLineEnv().

Here is the call graph for this function:

Here is the caller graph for this function:

RecreateLock()

void XrdCl::Env::RecreateLock ( )

inline

Definition at line 171 of file XrdClEnv.hh.

      {
        new( &pLock )XrdSysRWLock();
      }

Referenced by child().

Here is the caller graph for this function:

ReInitializeLock()

void XrdCl::Env::ReInitializeLock ( )

inline

Definition at line 160 of file XrdClEnv.hh.

      {
        // this is really shaky, but seems to work on linux and fork safety
        // is probably not required anywhere else
        pLock.UnLock();
        pLock.ReInitialize();
      }

References XrdSysRWLock::ReInitialize(), and XrdSysRWLock::UnLock().

Here is the call graph for this function:

UnLock()

void XrdCl::Env::UnLock ( )

inline

Definition at line 152 of file XrdClEnv.hh.

      {
        pLock.UnLock();
      }

References XrdSysRWLock::UnLock().

Here is the call graph for this function:

WriteLock()

void XrdCl::Env::WriteLock ( )

inline

Definition at line 144 of file XrdClEnv.hh.

      {
        pLock.WriteLock();
      }

References XrdSysRWLock::WriteLock().

Here is the call graph for this function:

---

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

• XrdClEnv.hh
• XrdClEnv.cc