<!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: XrdCms Namespace 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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><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="namespaces.html"><span>Namespace List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">XrdCms Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a6f3a5bfdc965304bc2f457cb966d5566"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="namespaceXrdCms.html#a6f3a5bfdc965304bc2f457cb966d5566a73c2ba9203fa994fc692d9b359f6bf1e">IsProxy</a> = 1,
<a class="el" href="namespaceXrdCms.html#a6f3a5bfdc965304bc2f457cb966d5566a94a5081a30e2bf5ba0a5872a754f8e5c">IsRedir</a> = 2,
<a class="el" href="namespaceXrdCms.html#a6f3a5bfdc965304bc2f457cb966d5566a49819d68a0f33af0f3ca4132c87667f7">IsTarget</a> = 4,
<a class="el" href="namespaceXrdCms.html#a6f3a5bfdc965304bc2f457cb966d5566aa801f939288a08ca511162eba9e446f4">IsMeta</a> = 8
}</td></tr>
<tr class="separator:a6f3a5bfdc965304bc2f457cb966d5566"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad6d691fc7a990f3b148015b4a45482f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCmsClient.html">XrdCmsClient</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXrdCms.html#ad6d691fc7a990f3b148015b4a45482f6">GetDefaultClient</a> (<a class="el" href="classXrdSysLogger.html">XrdSysLogger</a> *Logger, int opMode, int myPort)</td></tr>
<tr class="separator:ad6d691fc7a990f3b148015b4a45482f6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The following instantiation mode flags are passed to the instantiator (see comments that follow). They may be or'd together, depending on which mode the cms client should operate. They are defined as follows:</p>
<p>Obtain an instance of a configured <a class="el" href="classXrdCmsClient.html">XrdCmsClient</a>.</p>
<p>The following extern "C" function is called to obtain an instance of the <a class="el" href="classXrdCmsClient.html">XrdCmsClient</a> object. This is only used if the client is an actual plug-in as identified by the ofs.cmslib directive. Once the <a class="el" href="classXrdCmsClient.html">XrdCmsClient</a> object is obtained, its Configure() method is called to initialize the object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">logger</td><td>-> <a class="el" href="classXrdSysLogger.html">XrdSysLogger</a> to be tied to an <a class="el" href="classXrdSysError.html">XrdSysError</a> object for any messages. </td></tr>
<tr><td class="paramname">opMode</td><td>-> The operational mode as defined by the enum above. There are two general types of clients, IsRedir and IsTarget. The IsProxy and IsMeta modes are specialization of these two basic types. The plug-in must provide an instance of the one asked for whether or not they actually do anything.</td></tr>
</table>
</dd>
</dl>
<p>IsRedir clients are anything other than a data provider (i.e., data servers). These clients are expected to locate files and redirect a requestor to an actual data server.</p>
<p>IsTarget clients are typically data providers (i.e., data servers) but may actually do other functions are are allowed to redirect as well.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">myPort</td><td>-> The server's port number. </td></tr>
<tr><td class="paramname">theSS</td><td>-> The object that implements he underlying storage system. This object may be passed for historic reasons.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Success: a pointer to the appropriate object (IsRedir or IsTarget). <pre class="fragment"> Failure: a null pointer which causes initialization to fail. </pre></dd></dl>
<p>extern "C" <a class="el" href="classXrdCmsClient.html">XrdCmsClient</a> *XrdCmsGetClient(<a class="el" href="classXrdSysLogger.html">XrdSysLogger</a> *Logger, int opMode, int myPort <a class="el" href="classXrdOss.html">XrdOss</a> *theSS);Obtain an instance of a default unconfigured <a class="el" href="classXrdCmsClient.html">XrdCmsClient</a>.</p>
<p>The following function may be called to obtain an instance of the default <a class="el" href="classXrdCmsClient.html">XrdCmsClient</a> object. The Configure() method is <em>not</em> called before the object is returned. The parameters are the same as those for the function XrdCmsGetClient(), above. Note that you need not supply a pointer to the underlying storage system, as this is historic in nature.</p>
<dl class="section return"><dt>Returns</dt><dd>Success: a pointer to the appropriate object (IsRedir or IsTarget). <pre class="fragment"> Failure: a null pointer, neither ISRedir nor IsTarget has been
specified or there is insufficient memory. </pre> </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a6f3a5bfdc965304bc2f457cb966d5566"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a6f3a5bfdc965304bc2f457cb966d5566a73c2ba9203fa994fc692d9b359f6bf1e"></a>IsProxy</em> </td><td class="fielddoc">
<p>The role is proxy {plus one or more of the below}. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a6f3a5bfdc965304bc2f457cb966d5566a94a5081a30e2bf5ba0a5872a754f8e5c"></a>IsRedir</em> </td><td class="fielddoc">
<p>The role is manager and will redirect users. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a6f3a5bfdc965304bc2f457cb966d5566a49819d68a0f33af0f3ca4132c87667f7"></a>IsTarget</em> </td><td class="fielddoc">
<p>The role is server and will be a redirection target. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a6f3a5bfdc965304bc2f457cb966d5566aa801f939288a08ca511162eba9e446f4"></a>IsMeta</em> </td><td class="fielddoc">
<p>The role is meta {plus one or more of the above}. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ad6d691fc7a990f3b148015b4a45482f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCmsClient.html">XrdCmsClient</a>* XrdCms::GetDefaultClient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXrdSysLogger.html">XrdSysLogger</a> * </td>
<td class="paramname"><em>Logger</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>opMode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>myPort</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</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>
distrib
>
Fedora
>
18
>
x86_64
>
media
>
updates
>
by-pkgid
>
749e483016bbc41594aeb77eb13e3491
>
files
>
1891
