xrootd/XrdOss/XrdOssDefaultSS.hh

0001 #ifndef _XRDOSSDEFAULTSS_H
0002 #define _XRDOSSDEFAULTSS_H
0003 /******************************************************************************/
0004 /*                                                                            */
0005 /*                       X r d O s s D e f a u l t S S                        */
0006 /*                                                                            */
0007 /* (c) 2012 by the Board of Trustees of the Leland Stanford, Jr., University  */
0008 /*                            All Rights Reserved                             */
0009 /*   Produced by Andrew Hanushevsky for Stanford University under contract    */
0010 /*              DE-AC02-76-SFO0515 with the Department of Energy              */
0011 /*                                                                            */
0012 /* This file is part of the XRootD software suite.                            */
0013 /*                                                                            */
0014 /* XRootD is free software: you can redistribute it and/or modify it under    */
0015 /* the terms of the GNU Lesser General Public License as published by the     */
0016 /* Free Software Foundation, either version 3 of the License, or (at your     */
0017 /* option) any later version.                                                 */
0018 /*                                                                            */
0019 /* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
0020 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
0021 /* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
0022 /* License for more details.                                                  */
0023 /*                                                                            */
0024 /* You should have received a copy of the GNU Lesser General Public License   */
0025 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
0026 /* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
0027 /*                                                                            */
0028 /* The copyright holder's institutional names and contributor's names may not */
0029 /* be used to endorse or promote products derived from this software without  */
0030 /* specific prior written permission of the institution or contributor.       */
0031 /******************************************************************************/
0032
0033 #include "XrdVersion.hh"
0034 #include "XrdOss/XrdOss.hh"
0035
0036 //-----------------------------------------------------------------------------
0037 //! Get the default Storage System object.
0038 //!
0039 //! Include this file in your code to declare the external function that
0040 //! obtains a default version of the XrdOss object; then simply invoke it.
0041 //!
0042 //! @param  logger  the address of the logging object to direct messages.
0043 //! @param  cfg_fn  the address of the configuration file path.
0044 //! @param  urVer   the version string associated with your code. This is
0045 //!                 generated by the XrdVERSIONINFODEF macro and can be found
0046 //!                 in XrdVersion.hh include file. You must supply a compatible
0047 //!                 version identification string.
0048 //!
0049 //! @return XrdOss  pointer to a default configured storage system object.
0050 //!         0       a storage system object could not be created because of
0051 //!                 configration problems or your version is incompatible.
0052 //-----------------------------------------------------------------------------
0053
0054 extern XrdOss *XrdOssDefaultSS(XrdSysLogger   *logger,
0055                                const char     *cfg_fn,
0056                                XrdVersionInfo &urVer);
0057 #endif