kylefang/RestKit
1
0
Fork 0
mirror of https://github.com/zhigang1992/RestKit.git synced 2026-04-23 20:31:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clean up documentation and formatting in RKReachabilityObserver header.

Browse Source 
* Clean up asterisk placements in variable declarations.
* Add/fix appledoc section headers.
* Fill in missing documentation, parameter definitions, and return values.
* Clean up whitespace inconsistencies.
* Reorganize section layout for documentation clarity.
This commit is contained in:
Brian Morton
2012-02-07 02:22:30 -08:00
parent 27dbacca03
commit 4eb9de3a34
1 changed files with 180 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

259
Code/Network/RKReachabilityObserver.h
View File

@@ -21,20 +21,44 @@
#import <Foundation/Foundation.h>
#import <SystemConfiguration/SystemConfiguration.h>
/// Posted when the network state has changed
extern NSString *const RKReachabilityDidChangeNotification;
///-----------------------------------------------------------------------------
/// @name Constants
///-----------------------------------------------------------------------------
/// User Info key for accessing the SCNetworkReachabilityFlags from a RKReachabilityDidChangeNotification
extern NSString *const RKReachabilityFlagsUserInfoKey;
/**
Posted when the network state has changed
*/
extern NSString * const RKReachabilityDidChangeNotification;
/// Posted when network state has been initially determined
extern NSString *const RKReachabilityWasDeterminedNotification;
/**
User Info key for accessing the SCNetworkReachabilityFlags from a
RKReachabilityDidChangeNotification
*/
extern NSString * const RKReachabilityFlagsUserInfoKey;
/**
Posted when network state has been initially determined
*/
extern NSString * const RKReachabilityWasDeterminedNotification;
typedef enum {
RKReachabilityIndeterminate, // Network reachability not yet known
RKReachabilityNotReachable, // Network is not reachable
RKReachabilityReachableViaWiFi, // Network is reachable via a WiFi connection
RKReachabilityReachableViaWWAN // Network is reachable via a "wireless wide area network" (WWAN). i.e. GPRS, Edge, etc.
/**
Network reachability not yet known
*/
RKReachabilityIndeterminate,
/**
Network is not reachable
*/
RKReachabilityNotReachable,
/**
Network is reachable via a WiFi connection
*/
RKReachabilityReachableViaWiFi,
/**
Network is reachable via a "wireless wide area network" (WWAN). i.e. GPRS,
Edge, 3G, etc.
*/
RKReachabilityReachableViaWWAN
} RKReachabilityNetworkStatus;
/**
@@ -43,32 +67,132 @@ typedef enum {
When initialized, creates an SCReachabilityReg and schedules it for callback
notifications on the main dispatch queue. As notifications are intercepted from
SystemConfiguration, the observer will update its state and emit [RKReachabilityDidChangeNotifications](RKReachabilityDidChangeNotification)
SystemConfiguration, the observer will update its state and emit
`[RKReachabilityDidChangeNotifications](RKReachabilityDidChangeNotification)`
to inform listeners about state changes.
Portions of this software are derived from the Apple Reachability
code sample: http://developer.apple.com/library/ios/#samplecode/Reachability/Listings/Classes_Reachability_m.html
*/
@interface RKReachabilityObserver : NSObject {
NSString* _host;
NSString *_host;
SCNetworkReachabilityRef _reachabilityRef;
BOOL _reachabilityDetermined;
BOOL _monitoringLocalWiFi;
SCNetworkReachabilityFlags _reachabilityFlags;
}
///-----------------------------------------------------------------------------
/// @name Creating a Reachability Observer
///-----------------------------------------------------------------------------
/**
Creates and returns a RKReachabilityObserver instance observing reachability
changes to the hostname or IP address referenced in a given string. The
observer will monitor the ability to reach the specified remote host and emit
notifications when its reachability status changes.
The hostNameOrIPAddress will be introspected to determine if it contains an IP
address encoded into a string or a DNS name. The observer will be configured
appropriately based on the contents of the string.
@bug Note that iOS 5 has known issues with hostname based reachability
@param hostNameOrIPAddress An NSString containing a hostname or IP address to
be observed.
@return A reachability observer targeting the given hostname/IP address or nil
if it could not be observed.
*/
+ (RKReachabilityObserver *)reachabilityObserverForHost:(NSString *)hostNameOrIPAddress;
/**
Creates and returns a reachabilityObserverForInternet instance observing the
reachability to the Internet in general.
@return A reachability observer targeting INADDR_ANY or nil if it could not be
observed.
*/
+ (RKReachabilityObserver *)reachabilityObserverForInternet;
/**
Creates and returns a reachabilityObserverForInternet instance observing the
reachability to the Internet via the local WiFi interface. Internet access
available via the WWAN (3G, Edge, etc) will not be considered reachable.
@return A reachability observer targeting IN_LINKLOCALNETNUM or nil if it could
not be observed.
*/
+ (RKReachabilityObserver *)reachabilityObserverForLocalWifi;
/**
Creates and returns a RKReachabilityObserver instance observing reachability
changes to the sockaddr address provided.
@param address A socket address to determine reachability for.
@return A reachability observer targeting the given socket address or nil if it
could not be observed.
*/
+ (RKReachabilityObserver *)reachabilityObserverForAddress:(const struct sockaddr *)address;
/**
Creates and returns a RKReachabilityObserver instance observing reachability
changes to the IP address provided.
@param internetAddress A 32-bit integer representation of an IP address
@return A reachability observer targeting the given IP address or nil if it
could not be observed.
*/
+ (RKReachabilityObserver *)reachabilityObserverForInternetAddress:(in_addr_t)internetAddress;
/**
Returns a RKReachabilityObserver instance observing reachability changes to the
hostname or IP address referenced in a given string. The observer will monitor
the ability to reach the specified remote host and emit notifications when its
reachability status changes.
The hostNameOrIPAddress will be introspected to determine if it contains an IP
address encoded into a string or a DNS name. The observer will be configured
appropriately based on the contents of the string.
@bug Note that iOS 5 has known issues with hostname based reachability
@param hostNameOrIPAddress An NSString containing a hostname or IP address to
be observed.
@return A reachability observer targeting the given hostname/IP address or nil
if it could not be observed.
*/
- (id)initWithHost:(NSString *)hostNameOrIPAddress;
/**
Returns a RKReachabilityObserver instance observing reachability changes to the
sockaddr address provided.
@param address A socket address to determine reachability for.
@return A reachability observer targeting the given socket address or nil if it
could not be observed.
*/
- (id)initWithAddress:(const struct sockaddr *)address;
///-----------------------------------------------------------------------------
/// @name Determining the Host
///-----------------------------------------------------------------------------
/**
The remote hostname or IP address being observed for reachability.
*/
@property (nonatomic, readonly) NSString *host;
///-----------------------------------------------------------------------------
/// @name Managing Reachability States
///-----------------------------------------------------------------------------
/**
Returns YES if reachability has been determined
Current state of determining reachability
When initialized, RKReachabilityObserver instances are in an indeterminate
state to indicate that reachability status has not been yet established. After
the first callback is processed by the observer, the observer will answer
YES for reachabilityDetermined and networkStatus will return a determinate
the first callback is processed by the observer, the observer will answer YES
for reachabilityDetermined and networkStatus will return a determinate
response.
@return YES if reachability has been determined
@@ -76,80 +200,48 @@ typedef enum {
@property (nonatomic, readonly, getter=isReachabilityDetermined) BOOL reachabilityDetermined;
/**
Returns YES if the reachability observer is monitoring the local WiFi interface
Current network status as determined by examining the state of the currently
cached reachabilityFlags
When the local WiFi interface is being monitored only three reachability states are possible:
RKReachabilityIndeterminate, RKReachabilityNotReachable, or RKReachabilityReachableViaWiFi.
@return Status of the network as RKReachabilityNetworkStatus
*/
@property (nonatomic, readonly) RKReachabilityNetworkStatus networkStatus;
/**
Current state of the local WiFi interface's reachability
If the device has connectivity through a WWAN connection only it will consider the network
not reachable.
When the local WiFi interface is being monitored, only three reachability
states are possible:
- RKReachabilityIndeterminate
- RKReachabilityNotReachable
- RKReachabilityReachableViaWiFi
If the device has connectivity through a WWAN connection only it will consider
the network not reachable.
@see reachabilityObserverForLocalWifi
@return YES if the reachability observer is monitoring the local WiFi interface
*/
@property (nonatomic, readonly, getter=isMonitoringLocalWiFi) BOOL monitoringLocalWiFi;
/**
Returns the current network status as determined by examining the state of the currently
cached reachabilityFlags
*/
@property (nonatomic, readonly) RKReachabilityNetworkStatus networkStatus;
/**
Returns the reachability flags as of the last invocation of the reachability callback
The reachability flags as of the last invocation of the reachability callback
Each time the reachability callback is invoked with an asynchronous update of
reachability status the flags are cached and made accessible via the reachabilityFlags
method.
reachability status the flags are cached and made accessible via the
reachabilityFlags method.
Flags can also be directly obtained via [RKReachabilityObserver getFlags]
@see getFlags
@return The most recently cached reachability flags reflecting current network status
@return The most recently cached reachability flags reflecting current network
status.
*/
@property (nonatomic, readonly) SCNetworkReachabilityFlags reachabilityFlags;
////////////////////////////////////////////////////////////////////////////////////////////////
/**
Returns a RKReachabilityObserver instance observing reachability changes to
the hostname or IP address referenced in a given string. The observer
will monitor the ability to reach the specified remote host and emit notifications
when its reachability status changes.
The hostNameOrIPAddress will be introspected to determine if it contains an IP
address encoded into a string or a DNS name. The observer will be configured appropriately
based on the contents of the string.
@bug Note that iOS 5 has known issues with hostname based reachability
@param hostNameOrIPAddress An NSString containing a hostname or IP address to be observed
@return A reachability observer targeting the given hostname/IP address or nil if it could not
be observed.
*/
+ (RKReachabilityObserver *)reachabilityObserverForHost:(NSString *)hostNameOrIPAddress;
/**
Returns a reachabilityObserverForInternet instance observing the reachability to the
Internet in general.
@return A reachability observer targeting INADDR_ANY or nil if it could not be observed.
*/
+ (RKReachabilityObserver *)reachabilityObserverForInternet;
/**
Returns a reachabilityObserverForInternet instance observing the reachability to the
Internet via the local WiFi interface. Internet access available via the WWAN (3G, Edge, etc)
will not be considered reachable.
@return A reachability observer targeting IN_LINKLOCALNETNUM or nil if it could not be observed.
*/
+ (RKReachabilityObserver *)reachabilityObserverForLocalWifi;
+ (RKReachabilityObserver *)reachabilityObserverForAddress:(const struct sockaddr *)address;
+ (RKReachabilityObserver *)reachabilityObserverForInternetAddress:(in_addr_t)internetAddress;
- (id)initWithHost:(NSString *)hostNameOrIPAddress;
- (id)initWithAddress:(const struct sockaddr *)address;
/**
Acquires the current network reachability flags, answering YES if
successfully acquired; answering NO otherwise.
@@ -162,55 +254,64 @@ typedef enum {
*/
- (BOOL)getFlags;
////////////////////////////////////////////////////////////////////////////////////////////////
///-----------------------------------------------------------------------------
/// @name Reachability Introspection
///-----------------------------------------------------------------------------
/**
Returns YES when the Internet is reachable (via WiFi or WWAN)
@exception NSInternalInconsistencyException Raises an NSInternalInconsistencyException if called before reachability is determined
@exception NSInternalInconsistencyException Raises an
NSInternalInconsistencyException if called before reachability is determined
*/
- (BOOL)isNetworkReachable;
/**
Returns YES when we the network is reachable via WWAN
@exception NSInternalInconsistencyException Raises an NSInternalInconsistencyException if called before reachability is determined
@exception NSInternalInconsistencyException Raises an
NSInternalInconsistencyException if called before reachability is determined
*/
- (BOOL)isReachableViaWWAN;
/**
Returns YES when we the network is reachable via WiFi
@exception NSInternalInconsistencyException Raises an NSInternalInconsistencyException if called before reachability is determined
@exception NSInternalInconsistencyException Raises an
NSInternalInconsistencyException if called before reachability is determined
*/
- (BOOL)isReachableViaWiFi;
/**
Returns YES when WWAN may be available, but not active until a connection has been established.
@exception NSInternalInconsistencyException Raises an NSInternalInconsistencyException if called before reachability is determined
@exception NSInternalInconsistencyException Raises an
NSInternalInconsistencyException if called before reachability is determined
*/
- (BOOL)isConnectionRequired;
/**
Returns YES if a dynamic, on-demand connection is available
@exception NSInternalInconsistencyException Raises an NSInternalInconsistencyException if called before reachability is determined
@exception NSInternalInconsistencyException Raises an
NSInternalInconsistencyException if called before reachability is determined
*/
- (BOOL)isConnectionOnDemand;
/**
Returns YES if user intervention is required to initiate a connection
@exception NSInternalInconsistencyException Raises an NSInternalInconsistencyException if called before reachability is determined
@exception NSInternalInconsistencyException Raises an
NSInternalInconsistencyException if called before reachability is determined
*/
- (BOOL)isInterventionRequired;
/**
Returns a string representation of the currently cached reachabilityFlags for inspection
@return A string containing single character representations of the bits in an SCNetworkReachabilityFlags
@return A string containing single character representations of the bits in an
SCNetworkReachabilityFlags
*/
- (NSString *)reachabilityFlagsDescription;