XrdClEnv.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// XRootD is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// XRootD is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//------------------------------------------------------------------------------
 
#ifndef __XRD_CL_ENV_HH__
#define __XRD_CL_ENV_HH__
 
#include <map>
#include <string>
#include <utility>
#include <algorithm>
 
#include "XrdSys/XrdSysPthread.hh"
 
namespace XrdCl
{
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class Env
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual ~Env() {}
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool GetString( const std::string &key, std::string &value );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool PutString( const std::string &key, const std::string &value );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool DelString( const std::string &key );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool GetInt( const std::string &key, int &value );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool PutInt( const std::string &key, int value );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool DelInt( const std::string &key );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool GetPtr( const std::string &key, void* &value );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool PutPtr( const std::string &key, void* value );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool ImportInt( const std::string &key, const std::string &shellKey );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool ImportString( const std::string &key, const std::string &shellKey );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool GetDefaultIntValue( const std::string &key, int &value );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool GetDefaultStringValue( const std::string &key, std::string &value );
 
      //------------------------------------------------------------------------
      // Lock the environment for writing
      //------------------------------------------------------------------------
      void WriteLock()
      {
        pLock.WriteLock();
      }
 
      //------------------------------------------------------------------------
      // Unlock the environment
      //------------------------------------------------------------------------
      void UnLock()
      {
        pLock.UnLock();
      }
 
      //------------------------------------------------------------------------
      // Re-initialize the lock
      //------------------------------------------------------------------------
      void ReInitializeLock()
      {
        // this is really shaky, but seems to work on linux and fork safety
        // is probably not required anywhere else
        pLock.UnLock();
        pLock.ReInitialize();
      }
 
      //------------------------------------------------------------------------
      // Re-create the lock in the same memory
      //------------------------------------------------------------------------
      void RecreateLock()
      {
        new( &pLock )XrdSysRWLock();
      }
 
    private:
 
      //------------------------------------------------------------------------
      // Unify the key, make sure it is not case sensitive and strip it of
      // the XRD_ prefix if necessary
      //------------------------------------------------------------------------
      inline std::string UnifyKey( std::string key )
      {
        //----------------------------------------------------------------------
        // Make the key lower case
        //----------------------------------------------------------------------
        std::transform( key.begin(), key.end(), key.begin(), ::tolower );
 
        //----------------------------------------------------------------------
        // Strip the `xrd_` prefix if necessary
        //----------------------------------------------------------------------
        static const char prefix[] = "xrd_";
        if( key.compare( 0, sizeof( prefix ) - 1, prefix ) == 0 )
          key = key.substr( sizeof( prefix ) - 1 );
 
        return key;
      }
 
      std::string GetEnv( const std::string &key );
      typedef std::map<std::string, std::pair<std::string, bool> > StringMap;
      typedef std::map<std::string, std::pair<int, bool> >         IntMap;
      typedef std::map<std::string, void* >                        PtrMap;
 
      XrdSysRWLock pLock;
      StringMap    pStringMap;
      IntMap       pIntMap;
      PtrMap       pPtrMap;
  };
}
 
#endif // __XRD_CL_ENV_HH__