xrootd
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
XrdCl::FSExecutor Class Reference

Execute queries given as a commandline. More...

#include <XrdClFSExecutor.hh>

Collaboration diagram for XrdCl::FSExecutor:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

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

Private Types

typedef std::map< std::string, CommandCommandMap
 

Private Attributes

FileSystempFS
 
EnvpEnv
 
CommandMap pCommands
 

Detailed Description

Execute queries given as a commandline.

Member Typedef Documentation

◆ Command

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

Definition of a command.

◆ CommandMap

typedef std::map<std::string, Command> XrdCl::FSExecutor::CommandMap
private

◆ CommandParams

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

Definition of command argument list.

Constructor & Destructor Documentation

◆ FSExecutor()

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

Constructor

Parameters
urlthe server that the executor should contact
envexecution environment, the executor takes ownership over it

◆ ~FSExecutor()

XrdCl::FSExecutor::~FSExecutor ( )

Destructor.

Member Function Documentation

◆ AddCommand()

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

Add a command to the set of known commands

Parameters
namename of the command
commandfunction pointer
Returns
status

◆ 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

◆ GetEnv()

Env * XrdCl::FSExecutor::GetEnv ( )
inline

Get the environment.

References pEnv.

Member Data Documentation

◆ pCommands

CommandMap XrdCl::FSExecutor::pCommands
private

◆ pEnv

Env* XrdCl::FSExecutor::pEnv
private

Referenced by GetEnv().

◆ pFS

FileSystem* XrdCl::FSExecutor::pFS
private

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