/usr/include/ncbi-vdb/kdb/manager.h is in libncbi-vdb-dev 2.8.1+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 | /*===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
*/
#ifndef _h_kdb_manager_
#define _h_kdb_manager_
#ifndef _h_kdb_extern_
#include <kdb/extern.h>
#endif
/* #ifndef _h_kfs_directory_ */
/* #include <kfs/directory.h> */
/* #endif */
#include <kfs/defs.h> /* kpt types */
#include <stdarg.h>
#ifdef __cplusplus
extern "C" {
#endif
struct VPath;
struct KDirectory;
/*--------------------------------------------------------------------------
* KDBPathType
* extends KPathType from <kfs/defs.h>
*/
enum
{
/* must be handled carefully and can not go back to KDirectory
* as this value has a different meaning in KDirectory */
kptAny = 0,
kptDatabase = kptLastDefined,
kptTable,
kptIndex,
kptColumn,
/* these values may not be used in KDBManagerExists below */
kptMetadata,
kptPrereleaseTbl
};
/*--------------------------------------------------------------------------
* KDBManager
* opaque handle to library
*/
typedef struct KDBManager KDBManager;
/* AddRef
* Release
* all objects are reference counted
* NULL references are ignored
*/
KDB_EXTERN rc_t CC KDBManagerAddRef ( const KDBManager *self );
KDB_EXTERN rc_t CC KDBManagerRelease ( const KDBManager *self );
/* MakeRead
* MakeUpdate
* create library handle for specific use
* NB - only one of the functions will be implemented
*
* "wd" [ IN, NULL OKAY ] - optional working directory for
* accessing the file system. mgr will attach its own reference.
*/
KDB_EXTERN rc_t CC KDBManagerMakeRead ( const KDBManager **mgr, struct KDirectory const *wd );
KDB_EXTERN rc_t CC KDBManagerMakeUpdate ( KDBManager **mgr, struct KDirectory *wd );
/* Version
* returns the library version
*/
KDB_EXTERN rc_t CC KDBManagerVersion ( const KDBManager *self, uint32_t *version );
/* Exists
* returns true if requested object exists
*
* "type" [ IN ] - a KDBPathType
*
* "path" [ IN ] - NUL terminated path
*
* DEPRECATED:
* Should use KDBManagerPathType for reduced network thrashing.
*/
KDB_EXTERN bool CC KDBManagerExists ( const KDBManager *self, uint32_t type,
const char *name, ... );
KDB_EXTERN bool CC KDBManagerVExists ( const KDBManager *self, uint32_t type,
const char *name, va_list args );
/* Writable
* returns 0 if object is writable
* or a reason why if not
*
* "path" [ IN ] - NUL terminated path
*/
KDB_EXTERN rc_t CC KDBManagerWritable ( const KDBManager *self,
const char *path, ... );
KDB_EXTERN rc_t CC KDBManagerVWritable ( const KDBManager *self,
const char *path, va_list args );
/* Lock
* apply lock
*
* if object is already locked, the operation is idempotent
* and returns an rc state of rcLocked
*
* "path" [ IN ] - NUL terminated path
*/
KDB_EXTERN rc_t CC KDBManagerLock ( KDBManager *self, const char *path, ... );
KDB_EXTERN rc_t CC KDBManagerVLock ( KDBManager *self, const char *path, va_list args );
/* Unlock
* remove lock
*
* if object is already unlocked, the operation is idempotent
* and returns an rc state of rcUnlocked
*
* "path" [ IN ] - NUL terminated path
*/
KDB_EXTERN rc_t CC KDBManagerUnlock ( KDBManager *self, const char *path, ... );
KDB_EXTERN rc_t CC KDBManagerVUnlock ( KDBManager *self, const char *path, va_list args );
/* Drop
* drop an object based on its path
*
* "path" [ IN ] - NUL terminated string in UTF-8 giving path to the kdb object
*/
KDB_EXTERN rc_t CC KDBManagerDrop ( KDBManager *self, uint32_t obj_type, const char *path, ... );
KDB_EXTERN rc_t CC KDBManagerVDrop ( KDBManager *self, uint32_t obj_type, const char *path, va_list args );
/* RunPeriodicTasks
* executes periodic tasks, such as cache flushing
*/
KDB_EXTERN rc_t CC KDBManagerRunPeriodicTasks ( const KDBManager *self );
/* PathType
* check the path type of an object/directory path.
* this is an extension of the KDirectoryPathType and will return
* the KDirectory values if a path type is not specifically a
* kdb object
*/
KDB_EXTERN int CC KDBManagerPathTypeVP ( const KDBManager * self, const struct VPath * path );
KDB_EXTERN int CC KDBManagerPathType ( const KDBManager * self, const char *path, ... );
KDB_EXTERN int CC KDBManagerVPathType ( const KDBManager * self, const char *path, va_list args );
#ifdef __cplusplus
}
#endif
#endif /* _h_kdb_manager_ */
|