<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3.1"/> <title>xrootd: XrdCl::Status Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">xrootd </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceXrdCl.html">XrdCl</a></li><li class="navelem"><a class="el" href="structXrdCl_1_1Status.html">Status</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> | <a href="structXrdCl_1_1Status-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">XrdCl::Status Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>Procedure execution status. <a href="structXrdCl_1_1Status.html#details">More...</a></p> <p><code>#include <<a class="el" href="XrdClStatus_8hh_source.html">XrdClStatus.hh</a>></code></p> <div class="dynheader"> Inheritance diagram for XrdCl::Status:</div> <div class="dyncontent"> <div class="center"><img src="structXrdCl_1_1Status__inherit__graph.png" border="0" usemap="#XrdCl_1_1Status_inherit__map" alt="Inheritance graph"/></div> <map name="XrdCl_1_1Status_inherit__map" id="XrdCl_1_1Status_inherit__map"> <area shape="rect" id="node3" href="classXrdCl_1_1XRootDStatus.html" title="Request status." alt="" coords="5,80,152,107"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a0e9dda4786bc2a0cbeef11f31a82fd17"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Status.html#a0e9dda4786bc2a0cbeef11f31a82fd17">Status</a> (uint16_t st=<a class="el" href="namespaceXrdCl.html#a5c25351b39fdfcb21262d8373e900a07">stOK</a>, uint16_t cod=<a class="el" href="namespaceXrdCl.html#ad8088ab375cf684a4e29127eec8a3892">errNone</a>, uint32_t errN=0)</td></tr> <tr class="memdesc:a0e9dda4786bc2a0cbeef11f31a82fd17"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a0e9dda4786bc2a0cbeef11f31a82fd17">More...</a><br/></td></tr> <tr class="separator:a0e9dda4786bc2a0cbeef11f31a82fd17"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2ae613fd639134afd9c0dce811378d9b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Status.html#a2ae613fd639134afd9c0dce811378d9b">IsError</a> () const </td></tr> <tr class="memdesc:a2ae613fd639134afd9c0dce811378d9b"><td class="mdescLeft"> </td><td class="mdescRight">Error. <a href="#a2ae613fd639134afd9c0dce811378d9b">More...</a><br/></td></tr> <tr class="separator:a2ae613fd639134afd9c0dce811378d9b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a24cb1e6d451f6ea78cff2740b0aad68a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Status.html#a24cb1e6d451f6ea78cff2740b0aad68a">IsFatal</a> () const </td></tr> <tr class="memdesc:a24cb1e6d451f6ea78cff2740b0aad68a"><td class="mdescLeft"> </td><td class="mdescRight">Fatal error. <a href="#a24cb1e6d451f6ea78cff2740b0aad68a">More...</a><br/></td></tr> <tr class="separator:a24cb1e6d451f6ea78cff2740b0aad68a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abe6d4caca15fe384cadded7b733933d2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Status.html#abe6d4caca15fe384cadded7b733933d2">IsOK</a> () const </td></tr> <tr class="memdesc:abe6d4caca15fe384cadded7b733933d2"><td class="mdescLeft"> </td><td class="mdescRight">We're fine. <a href="#abe6d4caca15fe384cadded7b733933d2">More...</a><br/></td></tr> <tr class="separator:abe6d4caca15fe384cadded7b733933d2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a626ef52419c0a06e68e6bcb66c7348c2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Status.html#a626ef52419c0a06e68e6bcb66c7348c2">GetShellCode</a> () const </td></tr> <tr class="memdesc:a626ef52419c0a06e68e6bcb66c7348c2"><td class="mdescLeft"> </td><td class="mdescRight">Get the status code that may be returned to the shell. <a href="#a626ef52419c0a06e68e6bcb66c7348c2">More...</a><br/></td></tr> <tr class="separator:a626ef52419c0a06e68e6bcb66c7348c2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5a7807f312e57f448076692a99eb2abb"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Status.html#a5a7807f312e57f448076692a99eb2abb">ToString</a> () const </td></tr> <tr class="memdesc:a5a7807f312e57f448076692a99eb2abb"><td class="mdescLeft"> </td><td class="mdescRight">Create a string representation. <a href="#a5a7807f312e57f448076692a99eb2abb">More...</a><br/></td></tr> <tr class="separator:a5a7807f312e57f448076692a99eb2abb"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:a45bbb74e35f88bcb52d021d210a2b756"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Status.html#a45bbb74e35f88bcb52d021d210a2b756">status</a></td></tr> <tr class="memdesc:a45bbb74e35f88bcb52d021d210a2b756"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structXrdCl_1_1Status.html" title="Procedure execution status.">Status</a> of the execution. <a href="#a45bbb74e35f88bcb52d021d210a2b756">More...</a><br/></td></tr> <tr class="separator:a45bbb74e35f88bcb52d021d210a2b756"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a11246afb9aafe592f26e9334edaebae3"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Status.html#a11246afb9aafe592f26e9334edaebae3">code</a></td></tr> <tr class="memdesc:a11246afb9aafe592f26e9334edaebae3"><td class="mdescLeft"> </td><td class="mdescRight">Error type, or additional hints on what to do. <a href="#a11246afb9aafe592f26e9334edaebae3">More...</a><br/></td></tr> <tr class="separator:a11246afb9aafe592f26e9334edaebae3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af4ee08005fd33d45caa6efafb2aa9a7e"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structXrdCl_1_1Status.html#af4ee08005fd33d45caa6efafb2aa9a7e">errNo</a></td></tr> <tr class="memdesc:af4ee08005fd33d45caa6efafb2aa9a7e"><td class="mdescLeft"> </td><td class="mdescRight">Errno, if any. <a href="#af4ee08005fd33d45caa6efafb2aa9a7e">More...</a><br/></td></tr> <tr class="separator:af4ee08005fd33d45caa6efafb2aa9a7e"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Procedure execution status. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a0e9dda4786bc2a0cbeef11f31a82fd17"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">XrdCl::Status::Status </td> <td>(</td> <td class="paramtype">uint16_t </td> <td class="paramname"><em>st</em> = <code><a class="el" href="namespaceXrdCl.html#a5c25351b39fdfcb21262d8373e900a07">stOK</a></code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint16_t </td> <td class="paramname"><em>cod</em> = <code><a class="el" href="namespaceXrdCl.html#ad8088ab375cf684a4e29127eec8a3892">errNone</a></code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"><em>errN</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructor. </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a626ef52419c0a06e68e6bcb66c7348c2"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int XrdCl::Status::GetShellCode </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get the status code that may be returned to the shell. </p> <p>References <a class="el" href="structXrdCl_1_1Status.html#a11246afb9aafe592f26e9334edaebae3">code</a>, and <a class="el" href="structXrdCl_1_1Status.html#abe6d4caca15fe384cadded7b733933d2">IsOK()</a>.</p> </div> </div> <a class="anchor" id="a2ae613fd639134afd9c0dce811378d9b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool XrdCl::Status::IsError </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Error. </p> <p>References <a class="el" href="structXrdCl_1_1Status.html#a45bbb74e35f88bcb52d021d210a2b756">status</a>, and <a class="el" href="namespaceXrdCl.html#a3297c009f11a0c68b5de39c5ef1967bc">XrdCl::stError</a>.</p> </div> </div> <a class="anchor" id="a24cb1e6d451f6ea78cff2740b0aad68a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool XrdCl::Status::IsFatal </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fatal error. </p> <p>References <a class="el" href="structXrdCl_1_1Status.html#a45bbb74e35f88bcb52d021d210a2b756">status</a>, and <a class="el" href="namespaceXrdCl.html#a2d794f7438952f8098a5add251c04db0">XrdCl::stFatal</a>.</p> </div> </div> <a class="anchor" id="abe6d4caca15fe384cadded7b733933d2"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool XrdCl::Status::IsOK </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>We're fine. </p> <p>References <a class="el" href="structXrdCl_1_1Status.html#a45bbb74e35f88bcb52d021d210a2b756">status</a>, and <a class="el" href="namespaceXrdCl.html#a5c25351b39fdfcb21262d8373e900a07">XrdCl::stOK</a>.</p> <p>Referenced by <a class="el" href="structXrdCl_1_1Status.html#a626ef52419c0a06e68e6bcb66c7348c2">GetShellCode()</a>.</p> </div> </div> <a class="anchor" id="a5a7807f312e57f448076692a99eb2abb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string XrdCl::Status::ToString </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Create a string representation. </p> <p>Referenced by <a class="el" href="classXrdCl_1_1XRootDStatus.html#a606537f39dbf65b90f1c1ccce4202f38">XrdCl::XRootDStatus::ToStr()</a>.</p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a class="anchor" id="a11246afb9aafe592f26e9334edaebae3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint16_t XrdCl::Status::code</td> </tr> </table> </div><div class="memdoc"> <p>Error type, or additional hints on what to do. </p> <p>Referenced by <a class="el" href="structXrdCl_1_1Status.html#a626ef52419c0a06e68e6bcb66c7348c2">GetShellCode()</a>, and <a class="el" href="classXrdCl_1_1XRootDStatus.html#a606537f39dbf65b90f1c1ccce4202f38">XrdCl::XRootDStatus::ToStr()</a>.</p> </div> </div> <a class="anchor" id="af4ee08005fd33d45caa6efafb2aa9a7e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t XrdCl::Status::errNo</td> </tr> </table> </div><div class="memdoc"> <p>Errno, if any. </p> <p>Referenced by <a class="el" href="classXrdCl_1_1XRootDStatus.html#a606537f39dbf65b90f1c1ccce4202f38">XrdCl::XRootDStatus::ToStr()</a>.</p> </div> </div> <a class="anchor" id="a45bbb74e35f88bcb52d021d210a2b756"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint16_t XrdCl::Status::status</td> </tr> </table> </div><div class="memdoc"> <p><a class="el" href="structXrdCl_1_1Status.html" title="Procedure execution status.">Status</a> of the execution. </p> <p>Referenced by <a class="el" href="structXrdCl_1_1Status.html#a2ae613fd639134afd9c0dce811378d9b">IsError()</a>, <a class="el" href="structXrdCl_1_1Status.html#a24cb1e6d451f6ea78cff2740b0aad68a">IsFatal()</a>, and <a class="el" href="structXrdCl_1_1Status.html#abe6d4caca15fe384cadded7b733933d2">IsOK()</a>.</p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="XrdClStatus_8hh_source.html">XrdClStatus.hh</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3.1 </small></address> </body> </html>