Reachability Class Reference

Inheritance diagram for Reachability:

Collaboration diagram for Reachability:

Instance Methods
(BOOL)	- startNotifier
(void)	- stopNotifier
(NetworkStatus)	- currentReachabilityStatus
(BOOL)	- connectionRequired

Class Methods
(Reachability *)	+ reachabilityWithHostName:
(Reachability *)	+ reachabilityWithAddress:
(Reachability *)	+ reachabilityForInternetConnection
(Reachability *)	+ reachabilityForLocalWiFi

Protected Attributes
BOOL	localWiFiRef
SCNetworkReachabilityRef	reachabilityRef

Detailed Description

Definition at line 60 of file Reachability.h.

Method Documentation

connectionRequired

- (BOOL) connectionRequired

Definition at line 80 of file Reachability.m.

{
  NSAssert(reachabilityRef != NULL, @"connectionRequired called with NULL reachabilityRef");
  SCNetworkReachabilityFlags flags;
  if (SCNetworkReachabilityGetFlags(reachabilityRef, &flags))
  {
    return (flags & kSCNetworkReachabilityFlagsConnectionRequired);
  }
  return NO;
}

currentReachabilityStatus

- (NetworkStatus) currentReachabilityStatus

Definition at line 80 of file Reachability.m.

{
  NSAssert(reachabilityRef != NULL, @"currentNetworkStatus called with NULL reachabilityRef");
  NetworkStatus retVal = NotReachable;
  SCNetworkReachabilityFlags flags;
  if (SCNetworkReachabilityGetFlags(reachabilityRef, &flags))
  {
    if (localWiFiRef)
    {
      retVal = [self localWiFiStatusForFlags:flags];
    }
    else
    {
      retVal = [self networkStatusForFlags:flags];
    }
  }
  return retVal;
}

reachabilityForInternetConnection

+ (Reachability *) reachabilityForInternetConnection

Definition at line 80 of file Reachability.m.

{
  struct sockaddr_in zeroAddress;
  bzero(&zeroAddress, sizeof(zeroAddress));
  zeroAddress.sin_len = sizeof(zeroAddress);
  zeroAddress.sin_family = AF_INET;
  return [self reachabilityWithAddress:&zeroAddress];
}

reachabilityForLocalWiFi

+ (Reachability *) reachabilityForLocalWiFi

Definition at line 80 of file Reachability.m.

{
  struct sockaddr_in localWifiAddress;
  bzero(&localWifiAddress, sizeof(localWifiAddress));
  localWifiAddress.sin_len = sizeof(localWifiAddress);
  localWifiAddress.sin_family = AF_INET;
  // IN_LINKLOCALNETNUM is defined in <netinet/in.h> as 169.254.0.0
  localWifiAddress.sin_addr.s_addr = htonl(IN_LINKLOCALNETNUM);
  Reachability *retVal = [self reachabilityWithAddress:&localWifiAddress];
  if (retVal != NULL)
  {
    retVal->localWiFiRef = YES;
  }
  return retVal;
}

reachabilityWithAddress:

+ (Reachability *) reachabilityWithAddress:

(const struct sockaddr_in *)

hostAddress

Definition at line 80 of file Reachability.m.

                                         :(const struct sockaddr_in *)hostAddress;
{
  SCNetworkReachabilityRef reachability = SCNetworkReachabilityCreateWithAddress(
      kCFAllocatorDefault, (const struct sockaddr *)hostAddress);
  Reachability *retVal = NULL;
  if (reachability != NULL)
  {
    retVal = [[[self alloc] init] autorelease];
    if (retVal != NULL)
    {
      retVal->reachabilityRef = reachability;
      retVal->localWiFiRef = NO;
    }
  }
  return retVal;
}

reachabilityWithHostName:

+ (Reachability *) reachabilityWithHostName:

(NSString *)

hostName

Definition at line 80 of file Reachability.m.

                                          :(NSString *)hostName;
{
  Reachability *retVal = NULL;
  SCNetworkReachabilityRef reachability =
      SCNetworkReachabilityCreateWithName(NULL, [hostName UTF8String]);
  if (reachability != NULL)
  {
    retVal = [[[self alloc] init] autorelease];
    if (retVal != NULL)
    {
      retVal->reachabilityRef = reachability;
      retVal->localWiFiRef = NO;
    }
  }
  return retVal;
}

startNotifier

- (BOOL) startNotifier

Definition at line 80 of file Reachability.m.

{
  BOOL retVal = NO;
  SCNetworkReachabilityContext context = { 0, self, NULL, NULL, NULL };
  if (SCNetworkReachabilitySetCallback(reachabilityRef, ReachabilityCallback, &context))
  {
    if (SCNetworkReachabilityScheduleWithRunLoop(reachabilityRef, CFRunLoopGetCurrent(),
                                                 kCFRunLoopDefaultMode))
    {
      retVal = YES;
    }
  }
  return retVal;
}

stopNotifier

- (void) stopNotifier

Definition at line 80 of file Reachability.m.

{
  if (reachabilityRef != NULL)
  {
    SCNetworkReachabilityUnscheduleFromRunLoop(reachabilityRef, CFRunLoopGetCurrent(),
                                               kCFRunLoopDefaultMode);
  }
}

Field Documentation

localWiFiRef

- (BOOL) localWiFiRef

protected

Definition at line 62 of file Reachability.h.

reachabilityRef

- (SCNetworkReachabilityRef) reachabilityRef

protected

Definition at line 63 of file Reachability.h.

---

The documentation for this class was generated from the following files:

• Reachability.h
• Reachability.m