Update rcbox annotations for acquire/release functions
[glib.git] / gio / kqueue / kqueue-helper.h
blob418b38c0886f9abb4dd2027d7694e696b5e9e0fe
1 /*******************************************************************************
2 Copyright (c) 2011, 2012 Dmitry Matveev <me@dmitrymatveev.co.uk>
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 THE SOFTWARE.
21 *******************************************************************************/
23 #ifndef __KQUEUE_HELPER_H
24 #define __KQUEUE_HELPER_H
26 #include <gio/glocalfilemonitor.h>
27 #include <gio/gfilemonitor.h>
29 #include "dep-list.h"
31 typedef struct _GKqueueFileMonitor GKqueueFileMonitor;
33 /**
34 * kqueue_sub:
35 * @mon: a pointer to the GKqueueFileMonitor which holds this subscription
36 * @filename: a name of the file to monitor
37 * @fd: the associated file descriptor (used by kqueue)
39 * Represents a subscription on a file or directory. To check whether a
40 * subscription is active, check the fd field. If fd is not -1, it is an
41 * active subscription which can emit events from kqueue.
43 typedef struct
45 GKqueueFileMonitor *mon;
46 GFileMonitorSource *source;
47 gchar* filename;
48 gchar* basename;
49 int fd;
50 dep_list* deps;
51 int is_dir;
52 } kqueue_sub;
54 gboolean _kqsub_start_watching (kqueue_sub *sub);
55 void _kh_dir_diff (kqueue_sub *sub, gboolean handle_deleted);
56 void _km_add_missing (kqueue_sub *sub);
57 gboolean _km_scan_missing (kqueue_sub *check_this_sub_only);
58 void _km_remove (kqueue_sub *sub);
60 #endif /* __KQUEUE_HELPER_H */