overby.me
this repo has no description
1/*
2 * Copyright (c) 2012-2014, 2017, 2018 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23
24#ifndef _SCPREFS_OBSERVER_H
25#define _SCPREFS_OBSERVER_H
26
27#include <os/availability.h>
28#include <TargetConditionals.h>
29#include <sys/cdefs.h>
30#include <dispatch/dispatch.h>
31
32typedef enum {
33#if !TARGET_OS_IPHONE
34 scprefs_observer_type_mcx = 1,
35#else // !TARGET_OS_IPHONE
36 scprefs_observer_type_global = 2,
37 scprefs_observer_type_profile = 3,
38#endif // !TARGET_OS_IPHONE
39} _scprefs_observer_type;
40
41typedef struct _scprefs_observer_t * scprefs_observer_t;
42
43__BEGIN_DECLS
44
45/*!
46 @function prefs_observer_watch
47 @discussion Sends a notification to interested configuration agents
48 when a particular preference file has changed.
49 @param type the type of preference (MCX on OSX, Global/Profiles on iOS) to watch.
50 @param plist_name the name of the plist file to watch.
51 @param queue the queue to be called back on.
52 @param block the block to be called back on.
53 @result Returns the created preferences observer
54 */
55scprefs_observer_t
56_scprefs_observer_watch(_scprefs_observer_type type, const char *plist_name,
57 dispatch_queue_t queue, dispatch_block_t block);
58
59/*!
60 @function prefs_observer_watch
61 @discussion Cancells/deregisters the given preferences watcher.
62 @param observer the watcher to be cancelled.
63 */
64void
65_scprefs_observer_cancel(scprefs_observer_t observer);
66
67__END_DECLS
68
69#endif /* _SCPREFS_OBSERVER_H */