/usr/include/ncbi-vdb/kfs/lockfile.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 | /*===========================================================================
*
* 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_kfs_lockfile_
#define _h_kfs_lockfile_
#ifndef _h_kfs_extern_
#include <kfs/extern.h>
#endif
#ifndef _h_kfs_defs_
#include <kfs/defs.h>
#endif
#include <stdarg.h>
#ifdef __cplusplus
extern "C" {
#endif
/*--------------------------------------------------------------------------
* forwards
*/
struct KFile;
struct KDirectory;
/*--------------------------------------------------------------------------
* KLockFile
* a mutual exclusion lock on a file
* the lock is acquired upon creation
* and released upon destruction
*
* NB - only guaranteed to work when used from a single host
*/
typedef struct KLockFile KLockFile;
/* AddRef
* Release
*/
KFS_EXTERN rc_t CC KLockFileAddRef ( const KLockFile *self );
KFS_EXTERN rc_t CC KLockFileRelease ( const KLockFile *self );
/*--------------------------------------------------------------------------
* KDirectory
* interface extensions
*/
/* CreateLockFile
* attempts to create a KLockFile
*
* "lock" [ OUT ] - return parameter for newly created lock file
*
* "path" [ IN ] - NUL terminated string in directory-native
* character set denoting lock file
*/
KFS_EXTERN rc_t CC KDirectoryCreateLockFile ( struct KDirectory *self,
KLockFile **lock, const char *path, ... );
KFS_EXTERN rc_t CC KDirectoryVCreateLockFile ( struct KDirectory *self,
KLockFile **lock, const char *path, va_list args );
/* CreateExclusiveAccessFile
* opens a file with exclusive write access
*
* "f" [ OUT ] - return parameter for newly opened file
*
* "update" [ IN ] - if true, open in read/write mode
* otherwise, open in write-only mode
*
* "access" [ IN ] - standard Unix access mode, e.g. 0664
*
* "mode" [ IN ] - a creation mode ( see explanation above ).
*
* "path" [ IN ] - NUL terminated string in directory-native
* character set denoting target file
*/
KFS_EXTERN rc_t CC KDirectoryCreateExclusiveAccessFile ( struct KDirectory *self, struct KFile **f,
bool update, uint32_t access, KCreateMode mode, const char *path, ... );
KFS_EXTERN rc_t CC KDirectoryVCreateExclusiveAccessFile ( struct KDirectory *self, struct KFile **f,
bool update, uint32_t access, KCreateMode mode, const char *path, va_list args );
#ifdef __cplusplus
}
#endif
#endif /* _h_kfs_lockfile_ */
|