XrdCl::FSExecutor Class Reference

Execute queries given as a commandline. More...

#include <XrdClFSExecutor.hh>

Collaboration diagram for XrdCl::FSExecutor:

Public Types
typedef XRootDStatus(*	Command) (FileSystem *fs, Env *env, const CommandParams &args)
	Definition of a command. More...
typedef std::vector< std::string >	CommandParams
	Definition of command argument list. More...

Public Member Functions
	FSExecutor (const URL &url, Env *env=0)
	~FSExecutor ()
	Destructor. More...
bool	AddCommand (const std::string &name, Command command)
XRootDStatus	Execute (const CommandParams &args)
Env *	GetEnv ()
	Get the environment. More...

Detailed Description

Execute queries given as a commandline.

Definition at line 34 of file XrdClFSExecutor.hh.

Member Typedef Documentation

Command

typedef XRootDStatus(* XrdCl::FSExecutor::Command) (FileSystem *fs, Env *env, const CommandParams &args)

Definition of a command.

Definition at line 45 of file XrdClFSExecutor.hh.

CommandParams

typedef std::vector<std::string> XrdCl::FSExecutor::CommandParams

Definition of command argument list.

Definition at line 40 of file XrdClFSExecutor.hh.

Constructor & Destructor Documentation

FSExecutor()

XrdCl::FSExecutor::FSExecutor	(	const URL &	url,
		Env *	env = 0
	)

Constructor

Parameters

url	the server that the executor should contact
env	execution environment, the executor takes ownership over it

Definition at line 31 of file XrdClFSExecutor.cc.

                                                  :
    pFS( 0 )
  {
    pFS = new FileSystem( url );
    if( env )
      pEnv = env;
    else
      pEnv = new Env();
 
    pEnv->PutString( "ServerURL", url.GetURL() );
  }

References XrdCl::URL::GetURL(), and XrdCl::Env::PutString().

Here is the call graph for this function:

~FSExecutor()

XrdCl::FSExecutor::~FSExecutor

(

)

Destructor.

Definition at line 46 of file XrdClFSExecutor.cc.

  {
    delete pFS;
    delete pEnv;
  }

Member Function Documentation

AddCommand()

bool XrdCl::FSExecutor::AddCommand	(	const std::string &	name,
		Command	command
	)

Add a command to the set of known commands

Parameters

name	name of the command
command	function pointer

Returns

status

Definition at line 55 of file XrdClFSExecutor.cc.

  {
    Log *log = DefaultEnv::GetLog();
    CommandMap::iterator it = pCommands.find( name );
    if( it != pCommands.end() )
    {
      log->Error( AppMsg, "Unable to register command %s. Already exists.",
                          name.c_str() );
      return false;
    }
    pCommands.insert( std::make_pair( name, command ) );
    return true;
  }

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

Referenced by CreateExecutor().

Here is the call graph for this function:

Here is the caller graph for this function:

Execute()

XRootDStatus XrdCl::FSExecutor::Execute

(

const CommandParams &

args

)

Execute the given commandline

Parameters

args	: arguments for the commandline to be executed, first of which is the command name

Returns

status of the execution

Definition at line 69 of file XrdClFSExecutor.cc.

  {
    std::stringstream cmdline;
    std::ostream_iterator<std::string> oit(cmdline, " ");
    std::copy(args.begin(), args.end(), oit);
 
    Log *log = DefaultEnv::GetLog();
    log->Debug( AppMsg, "Executing: %s", cmdline.str().c_str() );
 
    if( args.empty() )
    {
      log->Dump( AppMsg, "Empty commandline." );
      return 1;
    }
 
    CommandParams::const_iterator parIt;
    int i = 0;
    for( parIt = args.begin(); parIt != args.end(); ++parIt, ++i )
      log->Dump( AppMsg, "  Param #%02d: '%s'", i, parIt->c_str() );
 
    //--------------------------------------------------------------------------
    // Extract the command name
    //--------------------------------------------------------------------------
    std::string commandName = args.front();
    CommandMap::iterator it = pCommands.find( commandName );
    if( it == pCommands.end() )
    {
      log->Error( AppMsg, "Unknown command: %s", commandName.c_str() );
      return XRootDStatus( stError, errUnknownCommand );
    }
 
    return it->second( pFS, pEnv, args );
  }

References XrdCl::AppMsg, XrdCl::Log::Debug(), XrdCl::Log::Dump(), XrdCl::Log::Error(), XrdCl::errUnknownCommand, XrdCl::DefaultEnv::GetLog(), and XrdCl::stError.

Referenced by ExecuteCommand(), and ExecuteInteractive().

Here is the call graph for this function:

Here is the caller graph for this function:

GetEnv()

Env* XrdCl::FSExecutor::GetEnv ( )

inline

Get the environment.

Definition at line 83 of file XrdClFSExecutor.hh.

      {
        return pEnv;
      }

Referenced by ExecuteCommand(), and ExecuteInteractive().

Here is the caller graph for this function:

---

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

• XrdClFSExecutor.hh
• XrdClFSExecutor.cc