xrootd
Public Member Functions | Public Attributes | List of all members
XrdCl::Status Struct Reference

Procedure execution status. More...

#include <XrdClStatus.hh>

Inheritance diagram for XrdCl::Status:
Inheritance graph
[legend]

Public Member Functions

 Status (uint16_t st=stOK, uint16_t cod=errNone, uint32_t errN=0)
 Constructor. More...
 
bool IsError () const
 Error. More...
 
bool IsFatal () const
 Fatal error. More...
 
bool IsOK () const
 We're fine. More...
 
int GetShellCode () const
 Get the status code that may be returned to the shell. More...
 
std::string ToString () const
 Create a string representation. More...
 

Public Attributes

uint16_t status
 Status of the execution. More...
 
uint16_t code
 Error type, or additional hints on what to do. More...
 
uint32_t errNo
 Errno, if any. More...
 

Detailed Description

Procedure execution status.

Constructor & Destructor Documentation

◆ Status()

XrdCl::Status::Status ( uint16_t  st = stOK,
uint16_t  cod = errNone,
uint32_t  errN = 0 
)
inline

Constructor.

Member Function Documentation

◆ GetShellCode()

int XrdCl::Status::GetShellCode ( ) const
inline

Get the status code that may be returned to the shell.

References code, IsOK(), and ToString().

◆ IsError()

bool XrdCl::Status::IsError ( ) const
inline

Error.

References status, and XrdCl::stError.

◆ IsFatal()

bool XrdCl::Status::IsFatal ( ) const
inline

Fatal error.

References status, and XrdCl::stFatal.

◆ IsOK()

bool XrdCl::Status::IsOK ( ) const
inline

We're fine.

References status, and XrdCl::stOK.

Referenced by GetShellCode().

◆ ToString()

std::string XrdCl::Status::ToString ( ) const

Create a string representation.

Referenced by GetShellCode().

Member Data Documentation

◆ code

uint16_t XrdCl::Status::code

Error type, or additional hints on what to do.

Referenced by GetShellCode().

◆ errNo

uint32_t XrdCl::Status::errNo

Errno, if any.

◆ status

uint16_t XrdCl::Status::status

Status of the execution.

Referenced by IsError(), IsFatal(), and IsOK().


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