include/subversion-1/svn_dso.h

   1 /**
   2  * @copyright
   3  * ====================================================================
   4  * Copyright (c) 2006 CollabNet.  All rights reserved.
   5  *
   6  * This software is licensed as described in the file COPYING, which
   7  * you should have received as part of this distribution.  The terms
   8  * are also available at http://subversion.tigris.org/license-1.html.
   9  * If newer versions of this license are posted there, you may use a
  10  * newer version instead, at your option.
  11  *
  12  * This software consists of voluntary contributions made by many
  13  * individuals.  For exact contribution history, see the revision
  14  * history and logs, available at http://subversion.tigris.org/.
  15  * ====================================================================
  16  * @endcopyright
  17  *
  18  * @file svn_dso.h
  19  * @brief DSO loading routines
  20  */
  21
  22
  23 \f
  24 #ifndef SVN_DSO_H
  25 #define SVN_DSO_H
  26
  27 #include <apr_dso.h>
  28
  29 #include "svn_error.h"
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif /* __cplusplus */
  34
  35 /**
  36  * Initialize the DSO loading routines.
  37  *
  38  * @note This should be called prior to the creation of any pool that
  39  *       is passed to a function that comes from a DSO, otherwise you
  40  *       risk having the DSO unloaded before all pool cleanup callbacks
  41  *       that live in the DSO have been executed.  If it is not called
  42  *       prior to @c svn_dso_load being used for the first time there
  43  *       will be a best effort attempt made to initialize the subsystem,
  44  *       but it will not be entirely thread safe and it risks running
  45  *       into the previously mentioned problems with DSO unloading and
  46  *       pool cleanup callbacks.
  47  *
  48  * @since New in 1.4.0.
  49  */
  50 void svn_dso_initialize(void);
  51
  52 #if APR_HAS_DSO
  53 /**
  54  * Attempt to load @a libname, returning it in @a dso.
  55  *
  56  * If @a libname cannot be loaded set @a dso to NULL and return
  57  * @c SVN_NO_ERROR.
  58  *
  59  * @note Due to pool lifetime issues DSOs are all loaded into a global
  60  *       pool, so you must be certain that there is a bounded number of
  61  *       them that will ever be loaded by the system, otherwise you will
  62  *       leak memory.
  63  *
  64  * @since New in 1.4.0.
  65  */
  66 svn_error_t *svn_dso_load(apr_dso_handle_t **dso, const char *libname);
  67 #endif /* APR_HAS_DSO */
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif /* __cplusplus */
  72
  73 #endif /* SVN_DSO_H */