subversion/libsvn_fs_base/bdb/lock-tokens-table.h

   1 /* lock-tokens-table.h : internal interface to ops on `lock-tokens' table
   2  *
   3  * ====================================================================
   4  * Copyright (c) 2000-2004 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  */
  17
  18 #ifndef SVN_LIBSVN_FS_LOCK_TOKENS_TABLE_H
  19 #define SVN_LIBSVN_FS_LOCK_TOKENS_TABLE_H
  20
  21 #include "svn_fs.h"
  22 #include "svn_error.h"
  23 #include "../trail.h"
  24 #include "../fs.h"
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif /* __cplusplus */
  29
  30 \f
  31 /* Open a `lock-tokens' table in ENV.  If CREATE is non-zero, create
  32    one if it doesn't exist.  Set *LOCK_TOKENS_P to the new table.
  33    Return a Berkeley DB error code.  */
  34 int svn_fs_bdb__open_lock_tokens_table(DB **locks_tokens_p,
  35                                        DB_ENV *env,
  36                                        svn_boolean_t create);
  37
  38
  39 /* Add a lock-token to the `lock-tokens' table in FS, as part of TRAIL.
  40    Use PATH as the key and LOCK_TOKEN as the value.
  41
  42    Warning: if PATH already exists as a key, then its value will be
  43    overwritten. */
  44 svn_error_t *
  45 svn_fs_bdb__lock_token_add(svn_fs_t *fs,
  46                            const char *path,
  47                            const char *lock_token,
  48                            trail_t *trail,
  49                            apr_pool_t *pool);
  50
  51
  52 /* Remove the lock-token whose key is PATH from the `lock-tokens'
  53    table of FS, as part of TRAIL.
  54
  55    If PATH doesn't exist as a key, return SVN_ERR_FS_NO_SUCH_LOCK.
  56 */
  57 svn_error_t *
  58 svn_fs_bdb__lock_token_delete(svn_fs_t *fs,
  59                               const char *path,
  60                               trail_t *trail,
  61                               apr_pool_t *pool);
  62
  63
  64 /* Retrieve the lock-token *LOCK_TOKEN_P pointed to by PATH from the
  65    `lock-tokens' table of FS, as part of TRAIL.  Perform all
  66    allocations in POOL.
  67
  68    If PATH doesn't exist as a key, return SVN_ERR_FS_NO_SUCH_LOCK.
  69
  70    If PATH points to a token which points to an expired lock, return
  71      SVN_ERR_FS_LOCK_EXPIRED.  (After this, both the token and lock are
  72      gone from their respective tables.)
  73
  74    If PATH points to a token which points to a non-existent lock,
  75      return SVN_ERR_FS_BAD_LOCK_TOKEN.  (After this, the token is also
  76      removed from the `lock-tokens' table.)
  77  */
  78 svn_error_t *
  79 svn_fs_bdb__lock_token_get(const char **lock_token_p,
  80                            svn_fs_t *fs,
  81                            const char *path,
  82                            trail_t *trail,
  83                            apr_pool_t *pool);
  84
  85
  86
  87 #ifdef __cplusplus
  88 }
  89 #endif /* __cplusplus */
  90
  91 #endif /* SVN_LIBSVN_FS_LOCK_TOKENS_TABLE_H */