XrdCms Namespace Reference

Enumerations

enum  { IsProxy = 1, IsRedir = 2, IsTarget = 4, IsMeta = 8 }

Functions

XrdCmsClientGetDefaultClient (XrdSysLogger *Logger, int opMode, int myPort)

Detailed Description

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:

Obtain an instance of a configured XrdCmsClient.

The following extern "C" function is called to obtain an instance of the XrdCmsClient object. This is only used if the client is an actual plug-in as identified by the ofs.cmslib directive. Once the XrdCmsClient object is obtained, its Configure() method is called to initialize the object.

Parameters:
logger -> XrdSysLogger to be tied to an XrdSysError object for any messages.
opMode -> 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.

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.

IsTarget clients are typically data providers (i.e., data servers) but may actually do other functions are are allowed to redirect as well.

Parameters:
myPort -> The server's port number.
theSS -> The object that implements he underlying storage system. This object may be passed for historic reasons.
Returns:
Success: a pointer to the appropriate object (IsRedir or IsTarget).

Failure: a null pointer which causes initialization to fail.

extern "C" XrdCmsClient *XrdCmsGetClient(XrdSysLogger *Logger, int opMode, int myPort XrdOss *theSS); Obtain an instance of a default unconfigured XrdCmsClient.

The following function may be called to obtain an instance of the default XrdCmsClient object. The Configure() method is *not* 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.

Returns:
Success: a pointer to the appropriate object (IsRedir or IsTarget).

Failure: a null pointer, neither ISRedir nor IsTarget has been specified or there is insufficient memory.


Enumeration Type Documentation

anonymous enum
Enumerator:
IsProxy 

The role is proxy {plus one or more of the below}.

IsRedir 

The role is manager and will redirect users.

IsTarget 

The role is server and will be a redirection target.

IsMeta 

The role is meta {plus one or more of the above}.


Function Documentation

XrdCmsClient* XrdCms::GetDefaultClient ( XrdSysLogger Logger,
int  opMode,
int  myPort 
)

Generated on 22 Oct 2014 for xrootd by  doxygen 1.6.1