XrdOucGMap.hh File Reference

#include "XrdOuc/XrdOucHash.hh"
#include "XrdOuc/XrdOucString.hh"
#include "XrdSys/XrdSysXSLock.hh"
Include dependency graph for XrdOucGMap.hh:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  XrdSecGMapEntry_t
class  XrdOucGMap

Defines

#define XrdOucGMapArgs

Functions

XrdOucGMapXrdOucgetGMap (XrdOucGMapArgs)

Define Documentation

#define XrdOucGMapArgs
Value:
XrdSysError       *eDest, \
                       const char        *mapfn, \
                       const char        *parms

Constructor

Parameters:
eDest -> The error object that must be used to print any errors or other messages (see XrdSysError.hh).
mapfn -> Path to the grid map file to be used. This pointer may be null; the default path will be tested then.
parms -> Argument string specified on the gridmap directive. It may be null or point to a null string if no parms exist. Curently supported parms: dbg to enable debug printouts to=timeout to set a timeout in secs on the validity of the information loaded from the file Default is 600 (10'); the reload is triggered by the first mapping request after the timeout is expired; the file is reloaded only if changed.

Function Documentation

XrdOucGMap* XrdOucgetGMap ( XrdOucGMapArgs   ) 

Obtain an instance of the XrdOucGMap object.

This extern "C" function is called when a shared library plug-in containing implementation of this class is loaded. It must exist in the shared library and must be thread-safe.

Parameters:
eDest -> The error object that must be used to print any errors or other messages (see XrdSysError.hh).
mapfn -> Path to the grid map file to be used. This pointer may be null; the default path will be tested then.
parms -> Argument string specified on the gridmap directive. It may be null or point to a null string if no parms exist.
Returns:
Success: A pointer to an instance of the XrdOucGMap object. Failure: A null pointer which causes initialization to fail.

The GMap object is used frequently in the course of creating new physical connections. The algorithms used by this object *must* be efficient and speedy; otherwise system performance will be severely degraded.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 19 Oct 2019 for xrootd by  doxygen 1.6.1