xrootd/XrdOuc/XrdOucPinPath.hh

0001 #ifndef __OOUC_PINPATH_HH__
0002 #define __OOUC_PINPATH_HH__
0003 /******************************************************************************/
0004 /*                                                                            */
0005 /*                      X r d O u c P i n P a t h . h h                       */
0006 /*                                                                            */
0007 /* (c) 2014 by the Board of Trustees of the Leland Stanford, Jr., University  */
0008 /*   Produced by Andrew Hanushevsky for Stanford University under contract    */
0009 /*              DE-AC02-76-SFO0515 with the Department of Energy              */
0010 /*                                                                            */
0011 /* This file is part of the XRootD software suite.                            */
0012 /*                                                                            */
0013 /* XRootD is free software: you can redistribute it and/or modify it under    */
0014 /* the terms of the GNU Lesser General Public License as published by the     */
0015 /* Free Software Foundation, either version 3 of the License, or (at your     */
0016 /* option) any later version.                                                 */
0017 /*                                                                            */
0018 /* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
0019 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
0020 /* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
0021 /* License for more details.                                                  */
0022 /*                                                                            */
0023 /* You should have received a copy of the GNU Lesser General Public License   */
0024 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
0025 /* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
0026 /*                                                                            */
0027 /* The copyright holder's institutional names and contributor's names may not */
0028 /* be used to endorse or promote products derived from this software without  */
0029 /* specific prior written permission of the institution or contributor.       */
0030 /******************************************************************************/
0031
0032 //-----------------------------------------------------------------------------
0033 //! XrdOucPinPath
0034 //!
0035 //! This function performs name versioning for shared library plug-ins. It is
0036 //! a public header and may be used by third parties to adhere to the plugin
0037 //! naming conventions.
0038 //-----------------------------------------------------------------------------
0039
0040 //-----------------------------------------------------------------------------
0041 //! Obtain the primary path to be used to load a plugin.
0042 //!
0043 //! @param  piPath  Pointer to the original (i.e. specified) plugin path.
0044 //! @param  noAltP  Upon return it is set to true or false.
0045 //!                 TRUE:  only the returned primary path may be used to load
0046 //!                        the plugin (i.e. no alternate path allowed).
0047 //!                 FALSE: the plugin should first be loaded using the returned
0048 //!                        primary path and if that fails, the original path
0049 //!                        (i.e. piPath) should be used to load the plugin.
0050 //! @param  buff    Pointer to a buffer that will hold the primary path.
0051 //! @param  blen    The size of the buffer.
0052 //!
0053 //! @return success The length of the primary path in buff.
0054 //! @return failure Zero (buffer is too small) but eqName is still set.
0055 //-----------------------------------------------------------------------------
0056
0057 extern int XrdOucPinPath(const char *piPath, bool &noAltP, char *buff, int blen);
0058
0059 #endif