|
| 1 | +/* CFNotificationCenter.h |
| 2 | + Copyright (c) 1998-2016, Apple Inc. and the Swift project authors |
| 3 | + |
| 4 | + Portions Copyright (c) 2014-2016 Apple Inc. and the Swift project authors |
| 5 | + Licensed under Apache License v2.0 with Runtime Library Exception |
| 6 | + See http://swift.org/LICENSE.txt for license information |
| 7 | + See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors |
| 8 | +*/ |
| 9 | + |
| 10 | +#if !defined(__COREFOUNDATION_CFNOTIFICATIONCENTER__) |
| 11 | +#define __COREFOUNDATION_CFNOTIFICATIONCENTER__ 1 |
| 12 | + |
| 13 | +#include <CoreFoundation/CFBase.h> |
| 14 | +#include <CoreFoundation/CFDictionary.h> |
| 15 | + |
| 16 | +CF_IMPLICIT_BRIDGING_ENABLED |
| 17 | +CF_EXTERN_C_BEGIN |
| 18 | + |
| 19 | +typedef CFStringRef CFNotificationName CF_EXTENSIBLE_STRING_ENUM; |
| 20 | + |
| 21 | +typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFNotificationCenter * CFNotificationCenterRef; |
| 22 | + |
| 23 | +typedef void (*CFNotificationCallback)(CFNotificationCenterRef center, void *observer, CFNotificationName name, const void *object, CFDictionaryRef userInfo); |
| 24 | + |
| 25 | +typedef CF_ENUM(CFIndex, CFNotificationSuspensionBehavior) { |
| 26 | + CFNotificationSuspensionBehaviorDrop = 1, |
| 27 | + // The server will not queue any notifications with this name and object while the process/app is in the background. |
| 28 | + CFNotificationSuspensionBehaviorCoalesce = 2, |
| 29 | + // The server will only queue the last notification of the specified name and object; earlier notifications are dropped. |
| 30 | + CFNotificationSuspensionBehaviorHold = 3, |
| 31 | + // The server will hold all matching notifications until the queue has been filled (queue size determined by the server) at which point the server may flush queued notifications. |
| 32 | + CFNotificationSuspensionBehaviorDeliverImmediately = 4 |
| 33 | + // The server will deliver notifications matching this registration whether or not the process is in the background. When a notification with this suspension behavior is matched, it has the effect of first flushing any queued notifications. |
| 34 | +}; |
| 35 | + |
| 36 | +CF_EXPORT CFTypeID CFNotificationCenterGetTypeID(void); |
| 37 | + |
| 38 | +CF_EXPORT CFNotificationCenterRef CFNotificationCenterGetLocalCenter(void); |
| 39 | + |
| 40 | +#if (TARGET_OS_MAC && !(TARGET_OS_EMBEDDED || TARGET_OS_IPHONE)) || TARGET_OS_WIN32 |
| 41 | +CF_EXPORT CFNotificationCenterRef CFNotificationCenterGetDistributedCenter(void); |
| 42 | +#endif |
| 43 | + |
| 44 | +CF_EXPORT CFNotificationCenterRef CFNotificationCenterGetDarwinNotifyCenter(void); |
| 45 | +// The Darwin Notify Center is based on the <notify.h> API. |
| 46 | +// For this center, there are limitations in the API. There are no notification "objects", |
| 47 | +// "userInfo" cannot be passed in the notification, and there are no suspension behaviors |
| 48 | +// (always "deliver immediately"). Other limitations in the <notify.h> API as described in |
| 49 | +// that header will also apply. |
| 50 | +// - In the CFNotificationCallback, the 'object' and 'userInfo' parameters must be ignored. |
| 51 | +// - CFNotificationCenterAddObserver(): the 'object' and 'suspensionBehavior' arguments are ignored. |
| 52 | +// - CFNotificationCenterAddObserver(): the 'name' argument may not be NULL (for this center). |
| 53 | +// - CFNotificationCenterRemoveObserver(): the 'object' argument is ignored. |
| 54 | +// - CFNotificationCenterPostNotification(): the 'object', 'userInfo', and 'deliverImmediately' arguments are ignored. |
| 55 | +// - CFNotificationCenterPostNotificationWithOptions(): the 'object', 'userInfo', and 'options' arguments are ignored. |
| 56 | +// The Darwin Notify Center has no notion of per-user sessions, all notifications are system-wide. |
| 57 | +// As with distributed notifications, the main thread's run loop must be running in one of the |
| 58 | +// common modes (usually kCFRunLoopDefaultMode) for Darwin-style notifications to be delivered. |
| 59 | +// NOTE: NULL or 0 should be passed for all ignored arguments to ensure future compatibility. |
| 60 | + |
| 61 | + |
| 62 | +CF_EXPORT void CFNotificationCenterAddObserver(CFNotificationCenterRef center, const void *observer, CFNotificationCallback callBack, CFStringRef name, const void *object, CFNotificationSuspensionBehavior suspensionBehavior); |
| 63 | + |
| 64 | +CF_EXPORT void CFNotificationCenterRemoveObserver(CFNotificationCenterRef center, const void *observer, CFNotificationName name, const void *object); |
| 65 | +CF_EXPORT void CFNotificationCenterRemoveEveryObserver(CFNotificationCenterRef center, const void *observer); |
| 66 | + |
| 67 | +CF_EXPORT void CFNotificationCenterPostNotification(CFNotificationCenterRef center, CFNotificationName name, const void *object, CFDictionaryRef userInfo, Boolean deliverImmediately); |
| 68 | + |
| 69 | +CF_ENUM(CFOptionFlags) { |
| 70 | + kCFNotificationDeliverImmediately = (1UL << 0), |
| 71 | + kCFNotificationPostToAllSessions = (1UL << 1) |
| 72 | +}; |
| 73 | + |
| 74 | +CF_EXPORT void CFNotificationCenterPostNotificationWithOptions(CFNotificationCenterRef center, CFNotificationName name, const void *object, CFDictionaryRef userInfo, CFOptionFlags options); |
| 75 | + |
| 76 | + |
| 77 | +CF_EXTERN_C_END |
| 78 | +CF_IMPLICIT_BRIDGING_DISABLED |
| 79 | + |
| 80 | +#endif /* ! __COREFOUNDATION_CFNOTIFICATIONCENTER__ */ |
| 81 | + |
0 commit comments