Something went wrong. Try again.
Cider Isn't Darwin Emulation, Really
Something went wrong. Try again.
17 kB · 439 lines
C
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440/* * Copyright (c) 2000, 2001, 2003-2005, 2008-2010, 2015, 2018 Apple Inc. All rights reserved. * * @APPLE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this * file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_LICENSE_HEADER_END@ */
#ifndef _SCDYNAMICSTORE_H#define _SCDYNAMICSTORE_H
#include <os/availability.h>#include <TargetConditionals.h>#include <sys/cdefs.h>#include <dispatch/dispatch.h>#include <CoreFoundation/CoreFoundation.h>
CF_IMPLICIT_BRIDGING_ENABLEDCF_ASSUME_NONNULL_BEGIN
/*! @header SCDynamicStore @discussion The SCDynamicStore API provides access to the key-value pairs in the dynamic store of a running system. The dynamic store contains, among other items, a copy of the configuration settings for the currently active set (which is sometimes refered to as the location) and information about the current network state.
The functions in the SCDynamicStore API allow you to find key-value pairs, add or remove key-value pairs, add or change values, and request notifications.
To use the functions of the SCDynamicStore API, you must first establish a dynamic store session using the SCDynamicStoreCreate function. When you are finished with the session, use CFRelease to close it. */
/*! @typedef SCDynamicStoreRef @discussion This is the handle to an open a dynamic store session with the system configuration daemon. */typedef const struct CF_BRIDGED_TYPE(id) __SCDynamicStore * SCDynamicStoreRef;
/*! @typedef SCDynamicStoreContext Structure containing user-specified data and callbacks for an SCDynamicStore session. @field version The version number of the structure type being passed in as a parameter to the SCDynamicStore creation function. This structure is version 0. @field info A C pointer to a user-specified block of data. @field retain The callback used to add a retain for the info field. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. The value may be NULL. @field release The calllback used to remove a retain previously added for the info field. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. The value may be NULL. @field copyDescription The callback used to provide a description of the info field. */typedef struct { CFIndex version; void * __nullable info; const void * __nonnull (* __nullable retain)(const void *info); void (* __nullable release)(const void *info); CFStringRef __nonnull (* __nullable copyDescription)(const void *info);} SCDynamicStoreContext;
/*! @typedef SCDynamicStoreCallBack @discussion Type of callback function used when notification of changes to the dynamic store is delivered. @param store The dynamic store session. @param changedKeys The list of changed keys.
The list includes any specific SCDynamicStore keys that changed (add, update, remove, notify) since the last call to SCDynamicStoreSetNotificationKeys or since the last notification callback. The list also includes any specific keys matching one of the pattern string(s) that changed.
An empty list indicates that the SCDynamicStore server restarted and that any assumptions based on prior content of the SCDynamicStore should be disgarded.
@param info A C pointer to a user-specified block of data. */typedef void (*SCDynamicStoreCallBack) ( SCDynamicStoreRef store, CFArrayRef changedKeys, void * __nullable info );
__BEGIN_DECLS
/*! @function SCDynamicStoreGetTypeID @discussion Returns the type identifier of all SCDynamicStore instances. */CFTypeIDSCDynamicStoreGetTypeID (void) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreCreate @discussion Creates a new session used to interact with the dynamic store maintained by the System Configuration server. @param allocator The CFAllocator that should be used to allocate memory for the local dynamic store object. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @param name A string that describes the name of the calling process or plug-in of the caller. @param callout The function to be called when a watched value in the dynamic store is changed. A NULL value can be specified if no callouts are desired. @param context The SCDynamicStoreContext associated with the callout. @result Returns a reference to the new SCDynamicStore session. You must release the returned value. */SCDynamicStoreRef __nullableSCDynamicStoreCreate ( CFAllocatorRef __nullable allocator, CFStringRef name, SCDynamicStoreCallBack __nullable callout, SCDynamicStoreContext * __nullable context ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreCreateWithOptions @discussion Creates a new session used to interact with the dynamic store maintained by the System Configuration server. @param allocator The CFAllocator that should be used to allocate memory for the local dynamic store object. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @param name A string that describes the name of the calling process or plug-in of the caller. @param storeOptions A CFDictionary containing options for the dynamic store session (such as whether all keys added or set into the dynamic store should be per-session keys).
Currently available options include:
<TABLE BORDER> <TR> <TH>key</TD> <TH>value</TD> </TR> <TR> <TD>kSCDynamicStoreUseSessionKeys</TD> <TD>CFBooleanRef</TD> </TR> </TABLE>
A NULL value can be specified if no options are desired. @param callout The function to be called when a watched value in the dynamic store is changed. A NULL value can be specified if no callouts are desired. @param context The SCDynamicStoreContext associated with the callout. @result Returns a reference to the new SCDynamicStore session. You must release the returned value. */SCDynamicStoreRef __nullableSCDynamicStoreCreateWithOptions ( CFAllocatorRef __nullable allocator, CFStringRef name, CFDictionaryRef __nullable storeOptions, SCDynamicStoreCallBack __nullable callout, SCDynamicStoreContext * __nullable context ) API_AVAILABLE(macos(10.4)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
extern const CFStringRef kSCDynamicStoreUseSessionKeys API_AVAILABLE(macos(10.4)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0)); /* CFBoolean */
/*! @function SCDynamicStoreCreateRunLoopSource @discussion Creates a CFRunLoopSource object that can be added to the application's run loop. All dynamic store notifications are delivered using this run loop source. @param allocator The CFAllocator that should be used to allocate memory for this run loop source. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @param store A reference to the dynamic store session. @param order On platforms which support it, for source versions which support it, this parameter determines the order in which the sources which are ready to be processed are handled. A lower order number causes processing before higher order number sources. It is inadvisable to depend on the order number for any architectural or design aspect of code. In the absence of any reason to do otherwise, zero should be used. @result A reference to the new CFRunLoopSource. You must release the returned value.
*/CFRunLoopSourceRef __nullableSCDynamicStoreCreateRunLoopSource ( CFAllocatorRef __nullable allocator, SCDynamicStoreRef store, CFIndex order ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreSetDispatchQueue @discussion Initiates notifications for the Notification Keys in store to the callback contained in store. @param store A reference to the dynamic store session. @param queue The dispatch queue to run the callback function on. Pass NULL to disable notifications, and release the queue. @result Returns TRUE on success, FALSE on failure.
*/BooleanSCDynamicStoreSetDispatchQueue ( SCDynamicStoreRef store, dispatch_queue_t __nullable queue ) API_AVAILABLE(macos(10.6)) SPI_AVAILABLE(ios(4.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreCopyKeyList @discussion Returns an array of CFString keys representing the current dynamic store entries that match a specified pattern. @param store The dynamic store session. @param pattern A regex(3) regular expression pattern used to match the dynamic store keys. @result Returns the list of matching keys; NULL if an error was encountered. You must release the returned value. */CFArrayRef __nullableSCDynamicStoreCopyKeyList ( SCDynamicStoreRef __nullable store, CFStringRef pattern ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreAddValue @discussion Adds the key-value pair to the dynamic store if no such key already exists. @param store The dynamic store session. @param key The key of the value to add to the dynamic store. @param value The value to add to the dynamic store. @result Returns TRUE if the key was added; FALSE if the key was already present in the dynamic store or if an error was encountered. */BooleanSCDynamicStoreAddValue ( SCDynamicStoreRef __nullable store, CFStringRef key, CFPropertyListRef value ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreAddTemporaryValue @discussion Temporarily adds the key-value pair to the dynamic store if no such key already exists. Unless the key is updated by another session, the key-value pair will be removed automatically when the session is closed. @param store The dynamic store session. @param key The key of the value to add to the dynamic store. @param value The value to add to the dynamic store. @result Returns TRUE if the key was added; FALSE if the key was already present in the dynamic store or if an error was encountered. */BooleanSCDynamicStoreAddTemporaryValue ( SCDynamicStoreRef store, CFStringRef key, CFPropertyListRef value ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreCopyValue @discussion Gets the value of the specified key from the dynamic store. @param store The dynamic store session. @param key The key associated with the value you want to get. @result Returns the value from the dynamic store that is associated with the given key; NULL if no value was located or an error was encountered. You must release the returned value. */CFPropertyListRef __nullableSCDynamicStoreCopyValue ( SCDynamicStoreRef __nullable store, CFStringRef key ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreCopyMultiple @discussion Gets the values of multiple keys in the dynamic store. @param store The dynamic store session. @param keys The keys associated with the values you want to get; NULL if no specific keys are requested. @param patterns An array of regex(3) pattern strings used to match the keys; NULL if no key patterns are requested. @result Returns a dictionary containing the key-value pairs of specific keys and the key-value pairs of keys that matched the specified patterns; NULL if an error was encountered. You must release the returned value. */CFDictionaryRef __nullableSCDynamicStoreCopyMultiple ( SCDynamicStoreRef __nullable store, CFArrayRef __nullable keys, CFArrayRef __nullable patterns ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreSetValue @discussion Adds or replaces a value in the dynamic store for the specified key. @param store The dynamic store session. @param key The key you want to set. @param value The value to add to or replace in the dynamic store. @result Returns TRUE if the key was updated; FALSE if an error was encountered. */BooleanSCDynamicStoreSetValue ( SCDynamicStoreRef __nullable store, CFStringRef key, CFPropertyListRef value ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreSetMultiple @discussion Updates multiple values in the dynamic store. @param store The dynamic store session. @param keysToSet A dictionary of key-value pairs you want to set into the dynamic store. @param keysToRemove An array of keys you want to remove from the dynamic store. @param keysToNotify An array of keys to flag as changed (without changing their values). @result Returns TRUE if the dynamic store updates were successful; FALSE if an error was encountered. */BooleanSCDynamicStoreSetMultiple ( SCDynamicStoreRef __nullable store, CFDictionaryRef __nullable keysToSet, CFArrayRef __nullable keysToRemove, CFArrayRef __nullable keysToNotify ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreRemoveValue @discussion Removes the value of the specified key from the dynamic store. @param store The dynamic store session. @param key The key of the value you want to remove. @result Returns TRUE if the key was removed; FALSE if no value was located or an error was encountered. */BooleanSCDynamicStoreRemoveValue ( SCDynamicStoreRef __nullable store, CFStringRef key ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreNotifyValue @discussion Triggers a notification to be delivered for the specified key in the dynamic store. @param store The dynamic store session. @param key The key that should be flagged as changed. Any dynamic store sessions that are monitoring this key will received a notification. Note that the key's value is not updated. @result Returns TRUE if the notification was processed; FALSE if an error was encountered. */BooleanSCDynamicStoreNotifyValue ( SCDynamicStoreRef __nullable store, CFStringRef key ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreSetNotificationKeys @discussion Specifies a set of specific keys and key patterns that should be monitored for changes. @param store The dynamic store session being watched. @param keys An array of keys to be monitored; NULL if no specific keys are to be monitored. @param patterns An array of regex(3) pattern strings used to match keys to be monitored; NULL if no key patterns are to be monitored. @result Returns TRUE if the set of notification keys and patterns was successfully updated; FALSE if an error was encountered. */BooleanSCDynamicStoreSetNotificationKeys ( SCDynamicStoreRef store, CFArrayRef __nullable keys, CFArrayRef __nullable patterns ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreCopyNotifiedKeys @discussion Returns an array of CFString keys representing the dynamic store entries that have changed since this function was last called. If possible, your application should use the notification functions instead of polling for the list of changed keys returned by this function. @param store The dynamic store session. @result Returns the list of changed keys; NULL if an error was encountered. You must release the returned value. */CFArrayRef __nullableSCDynamicStoreCopyNotifiedKeys ( SCDynamicStoreRef store ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
__END_DECLS
CF_ASSUME_NONNULL_ENDCF_IMPLICIT_BRIDGING_DISABLED
#endif /* _SCDYNAMICSTORE_H */