Something went wrong. Try again.
Cider Isn't Darwin Emulation, Really
Something went wrong. Try again.
15 kB · 360 lines
C
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361/* * Copyright (c) 2003-2005, 2008-2010, 2015-2016, 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 _SCNETWORKREACHABILITY_H#define _SCNETWORKREACHABILITY_H
#include <os/availability.h>#include <TargetConditionals.h>#include <sys/cdefs.h>#include <sys/types.h>#include <sys/socket.h>#include <CoreFoundation/CoreFoundation.h>#include <SystemConfiguration/SCNetwork.h>#include <dispatch/dispatch.h>
CF_IMPLICIT_BRIDGING_ENABLEDCF_ASSUME_NONNULL_BEGIN
/*! @header SCNetworkReachability @discussion The SCNetworkReachability API allows an application to determine the status of a system's current network configuration and the reachability of a target host. In addition, reachability can be monitored with notifications that are sent when the status has changed.
"Reachability" reflects whether a data packet, sent by an application into the network stack, can leave the local computer. Note that reachability does <i>not</i> guarantee that the data packet will actually be received by the host.
When reachability is used without scheduling updates on a runloop or dispatch queue, the system will not generate DNS traffic and will be optimistic about its reply - it will assume that the target is reachable if there is a default route but a DNS query is needed to learn the address. When scheduled, the first callback will behave like an unscheduled call but subsequent calls will leverage DNS results.
When used on IPv6-only (NAT64+DNS64) networks, reachability checks for IPv4 address literals (either a struct sockaddr_in * or textual representations such as "192.0.2.1") will automatically give the result for the corresponding synthesized IPv6 address. On those networks, creating a CFSocketStream or NSURLSession to that address will send packets but trying to connect using BSD socket APIs will fail. */
/*! @typedef SCNetworkReachabilityRef @discussion This is the handle to a network address or name. */typedef const struct CF_BRIDGED_TYPE(id) __SCNetworkReachability * SCNetworkReachabilityRef;
/*! @typedef SCNetworkReachabilityContext Structure containing user-specified data and callbacks for SCNetworkReachability. @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);} SCNetworkReachabilityContext;
/*! @enum SCNetworkReachabilityFlags @discussion Flags that indicate whether the specified network nodename or address is reachable, whether a connection is required, and whether some user intervention may be required when establishing a connection. @constant kSCNetworkReachabilityFlagsTransientConnection This flag indicates that the specified nodename or address can be reached via a transient connection, such as PPP. @constant kSCNetworkReachabilityFlagsReachable This flag indicates that the specified nodename or address can be reached using the current network configuration. @constant kSCNetworkReachabilityFlagsConnectionRequired This flag indicates that the specified nodename or address can be reached using the current network configuration, but a connection must first be established.
As an example, this status would be returned for a dialup connection that was not currently active, but could handle network traffic for the target system. @constant kSCNetworkReachabilityFlagsConnectionOnTraffic This flag indicates that the specified nodename or address can be reached using the current network configuration, but a connection must first be established. Any traffic directed to the specified name or address will initiate the connection.
Note: this flag was previously named kSCNetworkReachabilityFlagsConnectionAutomatic @constant kSCNetworkReachabilityFlagsInterventionRequired This flag indicates that the specified nodename or address can be reached using the current network configuration, but a connection must first be established. In addition, some form of user intervention will be required to establish this connection, such as providing a password, an authentication token, etc.
Note: At the present time, this flag will only be returned in the case where you have a dial-on-traffic configuration (ConnectionOnTraffic), where an attempt to connect has already been made, and where some error (e.g. no dial tone, no answer, bad password, ...) was encountered during the automatic connection attempt. In this case the PPP controller will stop attempting to establish a connection until the user has intervened. @constant kSCNetworkReachabilityFlagsConnectionOnDemand This flag indicates that the specified nodename or address can be reached using the current network configuration, but a connection must first be established. The connection will be established "On Demand" by the CFSocketStream APIs. Other APIs will not establish the connection. @constant kSCNetworkReachabilityFlagsIsLocalAddress This flag indicates that the specified nodename or address is one associated with a network interface on the current system. @constant kSCNetworkReachabilityFlagsIsDirect This flag indicates that network traffic to the specified nodename or address will not go through a gateway, but is routed directly to one of the interfaces in the system. @constant kSCNetworkReachabilityFlagsIsWWAN This flag indicates that the specified nodename or address can be reached via an EDGE, GPRS, or other "cell" connection. */typedef CF_OPTIONS(uint32_t, SCNetworkReachabilityFlags) { kSCNetworkReachabilityFlagsTransientConnection = 1<<0, kSCNetworkReachabilityFlagsReachable = 1<<1, kSCNetworkReachabilityFlagsConnectionRequired = 1<<2, kSCNetworkReachabilityFlagsConnectionOnTraffic = 1<<3, kSCNetworkReachabilityFlagsInterventionRequired = 1<<4, kSCNetworkReachabilityFlagsConnectionOnDemand API_AVAILABLE(macos(6.0),ios(3.0)) = 1<<5, kSCNetworkReachabilityFlagsIsLocalAddress = 1<<16, kSCNetworkReachabilityFlagsIsDirect = 1<<17, kSCNetworkReachabilityFlagsIsWWAN API_UNAVAILABLE(macos) API_AVAILABLE(ios(2.0)) = 1<<18,
kSCNetworkReachabilityFlagsConnectionAutomatic = kSCNetworkReachabilityFlagsConnectionOnTraffic};
/*! @typedef SCNetworkReachabilityCallBack @discussion Type of the callback function used when the reachability of a network address or name changes. @param target The SCNetworkReachability reference being monitored for changes. @param flags The new SCNetworkReachabilityFlags representing the reachability status of the network address/name. @param info A C pointer to a user-specified block of data. */typedef void (*SCNetworkReachabilityCallBack) ( SCNetworkReachabilityRef target, SCNetworkReachabilityFlags flags, void * __nullable info );
__BEGIN_DECLS
/*! @function SCNetworkReachabilityCreateWithAddress @discussion Creates a reference to the specified network address. This reference can be used later to monitor the reachability of the target host. @param address The address of the desired host. @result Returns a reference to the new immutable SCNetworkReachabilityRef.
You must release the returned value. */SCNetworkReachabilityRef __nullableSCNetworkReachabilityCreateWithAddress ( CFAllocatorRef __nullable allocator, const struct sockaddr *address ) API_AVAILABLE(macos(10.3), ios(2.0));
/*! @function SCNetworkReachabilityCreateWithAddressPair @discussion Creates a reference to the specified network address. This reference can be used later to monitor the reachability of the target host. @param localAddress The local address associated with a network connection. If NULL, only the remote address is of interest. @param remoteAddress The remote address associated with a network connection. If NULL, only the local address is of interest. @result Returns a reference to the new immutable SCNetworkReachabilityRef.
You must release the returned value. */SCNetworkReachabilityRef __nullableSCNetworkReachabilityCreateWithAddressPair ( CFAllocatorRef __nullable allocator, const struct sockaddr * __nullable localAddress, const struct sockaddr * __nullable remoteAddress ) API_AVAILABLE(macos(10.3), ios(2.0));
/*! @function SCNetworkReachabilityCreateWithName @discussion Creates a reference to the specified network host or node name. This reference can be used later to monitor the reachability of the target host. @param nodename The node name of the desired host. This name would be the same as that passed to the gethostbyname(3) or getaddrinfo(3) functions. @result Returns a reference to the new immutable SCNetworkReachabilityRef.
You must release the returned value. */SCNetworkReachabilityRef __nullableSCNetworkReachabilityCreateWithName ( CFAllocatorRef __nullable allocator, const char *nodename ) API_AVAILABLE(macos(10.3), ios(2.0));
/*! @function SCNetworkReachabilityGetTypeID @discussion Returns the type identifier of all SCNetworkReachability instances. */CFTypeIDSCNetworkReachabilityGetTypeID (void) API_AVAILABLE(macos(10.3), ios(2.0));
/*! @function SCNetworkReachabilityGetFlags @discussion Determines if the given target is reachable using the current network configuration. @param target The network reference associated with the address or name to be checked for reachability. @param flags A pointer to memory that will be filled with the SCNetworkReachabilityFlags detailing the reachability of the specified target. @result Returns TRUE if the network connection flags are valid; FALSE if the status could not be determined. */BooleanSCNetworkReachabilityGetFlags ( SCNetworkReachabilityRef target, SCNetworkReachabilityFlags *flags ) API_AVAILABLE(macos(10.3), ios(2.0));
/*! @function SCNetworkReachabilitySetCallback @discussion Assigns a client to a target, which receives callbacks when the reachability of the target changes. @param target The network reference associated with the address or name to be checked for reachability. @param callout The function to be called when the reachability of the target changes. If NULL, the current client for the target is removed. @param context The SCNetworkReachabilityContext associated with the callout. The value may be NULL. @result Returns TRUE if the notification client was successfully set. */BooleanSCNetworkReachabilitySetCallback ( SCNetworkReachabilityRef target, SCNetworkReachabilityCallBack __nullable callout, SCNetworkReachabilityContext * __nullable context ) API_AVAILABLE(macos(10.3), ios(2.0));
/*! @function SCNetworkReachabilityScheduleWithRunLoop @discussion Schedules the given target with the given run loop and mode. @param target The address or name that is set up for asynchronous notifications. Must be non-NULL. @param runLoop A reference to a run loop on which the target should be scheduled. Must be non-NULL. @param runLoopMode The mode on which to schedule the target. Must be non-NULL. @result Returns TRUE if the target is scheduled successfully; FALSE otherwise. */BooleanSCNetworkReachabilityScheduleWithRunLoop ( SCNetworkReachabilityRef target, CFRunLoopRef runLoop, CFStringRef runLoopMode ) API_AVAILABLE(macos(10.3), ios(2.0));
/*! @function SCNetworkReachabilityUnscheduleFromRunLoop @discussion Unschedules the given target from the given run loop and mode. @param target The address or name that is set up for asynchronous notifications. Must be non-NULL. @param runLoop A reference to a run loop from which the target should be unscheduled. Must be non-NULL. @param runLoopMode The mode on which to unschedule the target. Must be non-NULL. @result Returns TRUE if the target is unscheduled successfully; FALSE otherwise. */BooleanSCNetworkReachabilityUnscheduleFromRunLoop ( SCNetworkReachabilityRef target, CFRunLoopRef runLoop, CFStringRef runLoopMode ) API_AVAILABLE(macos(10.3), ios(2.0));
/*! @function SCNetworkReachabilitySetDispatchQueue @discussion Schedule or unschedule callbacks for the given target on the given dispatch queue. @param target The address or name that is set up for asynchronous notifications. Must be non-NULL. @param queue A libdispatch queue to run the callback on. Pass NULL to unschedule callbacks. @result Returns TRUE if the target is scheduled or unscheduled successfully; FALSE otherwise. */BooleanSCNetworkReachabilitySetDispatchQueue ( SCNetworkReachabilityRef target, dispatch_queue_t __nullable queue ) API_AVAILABLE(macos(10.6), ios(4.0));
__END_DECLS
CF_ASSUME_NONNULL_ENDCF_IMPLICIT_BRIDGING_DISABLED
#endif /* _SCNETWORKREACHABILITY_H */