SCIPAddress.h

Go to the documentation of this file.

//
//  SCIPAddress.h
//  scl
//
//  Created by Viacheslav Smolensky on 11.08.09.
//  Copyright (c) 2007 - 2014 by Samond Development Corporation. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <scl/SCNetObject.h>
#import <scl/SCSubnetMask.h>

#define SCIPAddressClass @"SCIPAddress" ///< SCIPAddress class name

#pragma mark -
#pragma mark Predefined IP addresses constants

#define SC_NET_LOCAL_HOST              @"127.0.0.1"     ///< Local host IP address

#pragma mark -

@interface SCIPAddress : SCNetObject {
        SCUInteger fAddress; // Internal IP address representation
}

#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// Address text representation property
@property (nonatomic, retain, getter=address, setter=setAddress:) NSString *address;
// Address internal representation propery
@property (nonatomic, readonly, getter=raw) SCUInteger raw;
// Address class read only property
@property (nonatomic, retain, readonly, getter=addressClass) NSString *addressClass;
// Address class default classfull network mask read only property
@property (nonatomic, retain, readonly, getter=defaultMask) SCSubnetMask *defaultMask;
// Network address for classfull network read only property
@property (nonatomic, retain, readonly, getter=netAddress) SCIPAddress *netAddress;
// Broadcast address for classfull network read only property
@property (nonatomic, retain, readonly, getter=broadcastAddress) SCIPAddress *broadcastAddress;
// First regular address for classfull network read only property
@property (nonatomic, retain, readonly, getter=firstAddress) SCIPAddress *firstAddress;
// Last regular address for classfull network read only property
@property (nonatomic, retain, readonly, getter=lastAddress) SCIPAddress *lastAddress;
#endif

#pragma mark -
#pragma mark Creating IP Address

+ (SCIPAddress *)emptyAddress;

+ (SCIPAddress *)addressWithString:(NSString *)address;

+ (SCIPAddress *)addressWithAddress:(SCIPAddress *)address;

+ (SCIPAddress *)addressWithLocalHost;

+ (SCIPAddress *)addressWithDataDictionary:(NSDictionary *)dictionary;

+ (SCIPAddress *)addressWithDataDictionaryFromFile:(NSString *)path;

+ (SCIPAddress *)addressWithCoder:(NSCoder *)coder;

+ (SCIPAddress *)addressWithContentsOfSerializedFile:(NSString *)path;

+ (SCIPAddress *)addressWithStream:(SCStream *)stream;

+ (SCIPAddress *)addressWithFileStream:(NSString *)path;

#pragma mark -
#pragma mark Initializing IP Address

- (id)init;

- (id)initWithString:(NSString *)address;

- (id)initWithAddress:(SCIPAddress *)address;

- (id)initWithLocalHost;

#pragma mark -
#pragma mark Changing IP Address

- (void)setAddress:(NSString *)address;

- (void)copyAddress:(SCIPAddress *)address;

#pragma mark -
#pragma mark Querying IP Address

- (SCUInteger)raw;

- (SCUByte)octetAtIndex:(SCInteger)index;

- (SCUByte)firstOctet;

- (NSString *)address;

- (NSString *)description;

- (NSString *)addressClass;

- (SCSubnetMask *)defaultMask;

#pragma mark -
#pragma mark Comparing IP Addresses

- (BOOL)isEqual:(id)address;

- (BOOL)isEqualToAddress:(SCIPAddress *)address;

- (BOOL)isEqualToString:(NSString *)address;

#pragma mark -
#pragma mark Checking IP Address

- (BOOL)isClassA;

- (BOOL)isClassB;

- (BOOL)isClassC;

- (BOOL)isClassD;

- (BOOL)isClassE;

- (BOOL)isLocalHost;

- (BOOL)isMulticast;

- (BOOL)isExperimantal;

- (BOOL)isPrivate;

- (BOOL)isAddress;

#pragma mark -
#pragma mark Checking IP Address as a Network Address

- (BOOL)isNetAddress;

- (BOOL)isNetAddressWithMask:(SCSubnetMask *)mask;

- (BOOL)isNetAddressWithMaskString:(NSString *)mask;

- (BOOL)isNetAddressWithLength:(SCUByte)length;

- (BOOL)isNetAddressWithPrefix:(NSString *)prefix;

- (BOOL)isNetAddressWithWildcard:(NSString *)wildcard;

- (BOOL)isNetAddressWithCount:(SCUInteger)count;

#pragma mark -
#pragma mark Checking IP Address as a Host Address

- (BOOL)isHostAddress;

- (BOOL)isHostAddressWithMask:(SCSubnetMask *)mask;

- (BOOL)isHostAddressWithMaskString:(NSString *)mask;

- (BOOL)isHostAddressWithLength:(SCUByte)length;

- (BOOL)isHostAddressWithPrefix:(NSString *)prefix;

- (BOOL)isHostAddressWithWildcard:(NSString *)wildcard;

- (BOOL)isHostAddressWithCount:(SCUInteger)count;

#pragma mark -
#pragma mark Checking IP Addresses as a Broadcast Address

- (BOOL)isBroadcast;

- (BOOL)isBroadcastWithMask:(SCSubnetMask *)mask;

- (BOOL)isBroadcastWithMaskString:(NSString *)mask;

- (BOOL)isBroadcastWithLength:(SCUByte)length;

- (BOOL)isBroadcastWithPrefix:(NSString *)prefix;

- (BOOL)isBroadcastWithWildcard:(NSString *)wildcard;

- (BOOL)isBroadcastWithCount:(SCUInteger)count;

#pragma mark -
#pragma mark Querying Network Address

- (SCIPAddress *)netAddress;

- (SCIPAddress *)netAddressWithMask:(SCSubnetMask *)mask;

- (SCIPAddress *)netAddressWithMaskString:(NSString *)mask;

- (SCIPAddress *)netAddressWithLength:(SCUByte)length;

- (SCIPAddress *)netAddressWithPrefix:(NSString *)prefix;

- (SCIPAddress *)netAddressWithWildcard:(NSString *)wildcard;

- (SCIPAddress *)netAddressWithCount:(SCUInteger)count;

#pragma mark -
#pragma mark Querying Broadcast Address

- (SCIPAddress *)broadcastAddress;

- (SCIPAddress *)broadcastAddressWithMask:(SCSubnetMask *)mask;

- (SCIPAddress *)broadcastAddressWithMaskString:(NSString *)mask;

- (SCIPAddress *)broadcastAddressWithLength:(SCUByte)length;

- (SCIPAddress *)broadcastAddressWithPrefix:(NSString *)prefix;

- (SCIPAddress *)broadcastAddressWithWildcard:(NSString *)wildcard;

- (SCIPAddress *)broadcastAddressWithCount:(SCUInteger)count;

#pragma mark -
#pragma mark Querying First Reqular Address

- (SCIPAddress *)firstAddress;

- (SCIPAddress *)firstAddressWithMask:(SCSubnetMask *)mask;

- (SCIPAddress *)firstAddressWithMaskString:(NSString *)mask;

- (SCIPAddress *)firstAddressWithLength:(SCUByte)length;

- (SCIPAddress *)firstAddressWithPrefix:(NSString *)prefix;

- (SCIPAddress *)firstAddressWithWildcard:(NSString *)wildcard;

- (SCIPAddress *)firstAddressWithCount:(SCUInteger)count;

#pragma mark -
#pragma mark Querying Last Reqular Address

- (SCIPAddress *)lastAddress;

- (SCIPAddress *)lastAddressWithMask:(SCSubnetMask *)mask;

- (SCIPAddress *)lastAddressWithMaskString:(NSString *)mask;

- (SCIPAddress *)lastAddressWithLength:(SCUByte)length;

- (SCIPAddress *)lastAddressWithPrefix:(NSString *)prefix;

- (SCIPAddress *)lastAddressWithWildcard:(NSString *)wildcard;

- (SCIPAddress *)lastAddressWithCount:(SCUInteger)count;

@end