Change JNLIB license to LGPLv3+ or GPLv2+.
[gnupg.git] / common / dotlock.h
1 /* dotlock.h - dotfile locking declarations
2  * Copyright (C) 2000, 2001, 2006, 2011 Free Software Foundation, Inc.
3  *
4  * This file is part of JNLIB, which is a subsystem of GnuPG.
5  *
6  * JNLIB is free software; you can redistribute it and/or modify it
7  * under the terms of either
8  *
9  *   - the GNU Lesser General Public License as published by the Free
10  *     Software Foundation; either version 3 of the License, or (at
11  *     your option) any later version.
12  *
13  * or
14  *
15  *   - the GNU General Public License as published by the Free
16  *     Software Foundation; either version 2 of the License, or (at
17  *     your option) any later version.
18  *
19  * or both in parallel, as here.
20  *
21  * JNLIB is distributed in the hope that it will be useful, but
22  * WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * General Public License for more details.
25  *
26  * You should have received a copies of the GNU General Public License
27  * and the GNU Lesser General Public License along with this program;
28  * if not, see <http://www.gnu.org/licenses/>.
29  */
30
31 #ifndef LIBJNLIB_DOTLOCK_H
32 #define LIBJNLIB_DOTLOCK_H
33
34 /* See dotlock.c for a description.  */
35
36 #ifdef DOTLOCK_EXT_SYM_PREFIX
37 # ifndef _DOTLOCK_PREFIX
38 #  define _DOTLOCK_PREFIX1(x,y)  x ## y
39 #  define _DOTLOCK_PREFIX2(x,y) _DOTLOCK_PREFIX1(x,y)
40 #  define _DOTLOCK_PREFIX(x)    _DOTLOCK_PREFIX2(DOTLOCK_EXT_SYM_PREFIX,x)
41 # endif /*_DOTLOCK_PREFIX*/
42 # define dotlock_disable          _DOTLOCK_PREFIX(dotlock_disable)
43 # define dotlock_create           _DOTLOCK_PREFIX(dotlock_create)
44 # define dotlock_set_fd           _DOTLOCK_PREFIX(dotlock_set_fd)
45 # define dotlock_get_fd           _DOTLOCK_PREFIX(dotlock_get_fd)
46 # define dotlock_destroy          _DOTLOCK_PREFIX(dotlock_destroy)
47 # define dotlock_take             _DOTLOCK_PREFIX(dotlock_take)
48 # define dotlock_release          _DOTLOCK_PREFIX(dotlock_release)
49 # define dotlock_remove_lockfiles _DOTLOCK_PREFIX(dotlock_remove_lockfiles)
50 #endif /*DOTLOCK_EXT_SYM_PREFIX*/
51
52 #ifdef __cplusplus
53 extern "C"
54 {
55 #if 0
56 }
57 #endif
58 #endif
59
60
61 struct dotlock_handle;
62 typedef struct dotlock_handle *dotlock_t;
63
64 void dotlock_disable (void);
65 dotlock_t dotlock_create (const char *file_to_lock, unsigned int flags);
66 void dotlock_set_fd (dotlock_t h, int fd);
67 int  dotlock_get_fd (dotlock_t h);
68 void dotlock_destroy (dotlock_t h);
69 int dotlock_take (dotlock_t h, long timeout);
70 int dotlock_release (dotlock_t h);
71 void dotlock_remove_lockfiles (void);
72
73 #ifdef __cplusplus
74 }
75 #endif
76 #endif /*LIBJNLIB_DOTLOCK_H*/