SCSubnet.h

Go to the documentation of this file.

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

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

#define SCSubnetClass @"SCSubnet" ///< SCSubnet class name

#pragma mark -

@interface SCSubnet : SCNetObject {
        SCIPAddress *fAddress; // Subnet address
        SCSubnetMask *fMask;   // Subnet mask
}

#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// Subnet address read only property
@property (nonatomic, retain, readonly, getter=address) SCIPAddress *address;
// Subnet address read only property
@property (nonatomic, retain, readonly, getter=netAddress) SCIPAddress *netAddress;
// Subnet broadcast read only property
@property (nonatomic, retain, readonly, getter=broadcastAddress) SCIPAddress *broadcastAddress;
// Subnet first regular address read only property
@property (nonatomic, retain, readonly, getter=firstAddress) SCIPAddress *firstAddress;
// Subnet last regular address read only property
@property (nonatomic, retain, readonly, getter=lastAddress) SCIPAddress *lastAddress;
// Subnet mask read only property
@property (nonatomic, retain, readonly, getter=mask) SCSubnetMask *mask;
// Subnet prefix read only property
@property (nonatomic, retain, readonly, getter=prefix) NSString *prefix;
// Subnet length read only property
@property (nonatomic, readonly, getter=length) SCUByte length;
// Subnet wildcard mask read only property
@property (nonatomic, retain, readonly, getter=wildcard) NSString *wildcard;
// Subnet string with mask read only property
@property (nonatomic, retain, readonly, getter=stringWithMask) NSString *stringWithMask;
// Subnet string with prefix read only property
@property (nonatomic, retain, readonly, getter=stringWithPrefix) NSString *stringWithPrefix;
// Subnet hosts count read only property
@property (nonatomic, readonly, getter=count) SCUInteger count;
// Subnet class read only property
@property (nonatomic, readonly, getter=subnetClass) NSString *subnetClass;
#endif

#pragma mark -
#pragma mark Creating Subnets

+ (SCSubnet *)subnet;

+ (SCSubnet *)subnetWithAddress:(SCIPAddress *)address;

+ (SCSubnet *)subnetWithAddress:(SCIPAddress *)address mask:(SCSubnetMask *)mask;

+ (SCSubnet *)subnetWithAddress:(SCIPAddress *)address maskString:(NSString *)mask;

+ (SCSubnet *)subnetWithAddress:(SCIPAddress *)address length:(SCUByte)length;

+ (SCSubnet *)subnetWithAddress:(SCIPAddress *)address prefix:(NSString *)prefix;

+ (SCSubnet *)subnetWithAddress:(SCIPAddress *)address wildcard:(NSString *)wildcard;

+ (SCSubnet *)subnetWithAddress:(SCIPAddress *)address count:(SCUInteger)count;

+ (SCSubnet *)subnetWithString:(NSString *)address;

+ (SCSubnet *)subnetWithString:(NSString *)address mask:(SCSubnetMask *)mask;

+ (SCSubnet *)subnetWithString:(NSString *)address maskString:(NSString *)mask;

+ (SCSubnet *)subnetWithString:(NSString *)address length:(SCUByte)length;

+ (SCSubnet *)subnetWithString:(NSString *)address prefix:(NSString *)prefix;

+ (SCSubnet *)subnetWithString:(NSString *)address wildcard:(NSString *)wildcard;

+ (SCSubnet *)subnetWithString:(NSString *)address count:(SCUInteger)count;

+ (SCSubnet *)subnetWithSubnet:(SCSubnet *)subnet;

+ (SCSubnet *)subnetWithInternet;

+ (SCSubnet *)subnetWithStartAddress:(SCIPAddress *)start endAddress:(SCIPAddress *)end;

+ (SCSubnet *)subnetWithStartString:(NSString *)start endString:(NSString *)end;

+ (SCSubnet *)subnetWithSubnets:(NSArray *)subnets;

+ (SCSubnet *)subnetWithDataDictionary:(NSDictionary *)dictionary;

+ (SCSubnet *)subnetWithDataDictionaryFromFile:(NSString *)path;

+ (SCSubnet *)subnetWithCoder:(NSCoder *)coder;

+ (SCSubnet *)subnetWithContentsOfSerializedFile:(NSString *)path;

+ (SCSubnet *)subnetWithStream:(SCStream *)stream;

+ (SCSubnet *)subnetWithFileStream:(NSString *)path;

#pragma mark -
#pragma mark Initializing Subnets

- (id)init;

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

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

- (id)initWithAddress:(SCIPAddress *)address maskString:(NSString *)mask;

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

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

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

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

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

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

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

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

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

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

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

- (id)initWithSubnet:(SCSubnet *)subnet;

- (id)initWithInternet;

- (id)initWithStartAddress:(SCIPAddress *)start endAddress:(SCIPAddress *)end;

- (id)initWithStartString:(NSString *)start endString:(NSString *)end;

- (id)initWithSubnets:(NSArray *)subnets;

#pragma mark -
#pragma mark Comparing Subnets

- (BOOL)isEqual:(id)subnet;

- (BOOL)isEqualToSubnet:(SCSubnet *)subnet;

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

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

- (BOOL)isEqualToAddress:(SCIPAddress *)address maskString:(NSString *)mask;

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

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

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

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

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

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

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

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

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

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

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

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

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

- (BOOL)isEqualToLength:(SCUByte)length;

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

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

- (BOOL)isEqualToCount:(SCUInteger)count;

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

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

- (BOOL)isEqualToStartAddress:(SCIPAddress *)start endAddress:(SCIPAddress *)end;

- (BOOL)isEqualToStartString:(NSString *)start endString:(NSString *)end;

- (BOOL)isEqualToSubnets:(NSArray *)subnets;

#pragma mark -
#pragma mark Setting Subnets

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

- (void)setAddress:(SCIPAddress *)address mask:(SCSubnetMask *)mask;

- (void)setAddress:(SCIPAddress *)address maskString:(NSString *)mask;

- (void)setAddress:(SCIPAddress *)address length:(SCUByte)length;

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

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

- (void)setAddress:(SCIPAddress *)address count:(SCUInteger)count;

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

- (void)setString:(NSString *)address mask:(SCSubnetMask *)mask;

- (void)setString:(NSString *)address maskString:(NSString *)mask;

- (void)setString:(NSString *)address length:(SCUByte)length;

- (void)setString:(NSString *)address prefix:(NSString *)prefix;

- (void)setString:(NSString *)address wildcard:(NSString *)wildcard;

- (void)setString:(NSString *)address count:(SCUInteger)count;

- (void)copySubnet:(SCSubnet *)subnet;

- (void)setStartAddress:(SCIPAddress *)start endAddress:(SCIPAddress *)end;

- (void)setStartString:(NSString *)start endString:(NSString *)end;

- (void)setSubnets:(NSArray *)subnets;

#pragma mark -
#pragma mark Querying Subnet Related Addresses

- (SCIPAddress *)netAddress;

- (SCIPAddress *)broadcastAddress;

- (SCIPAddress *)firstAddress;

- (SCIPAddress *)lastAddress;

#pragma mark -
#pragma mark Querying Subnet

- (SCIPAddress *)address;

- (SCSubnetMask *)mask;

- (NSString *)prefix;

- (SCUByte)length;

- (NSString *)wildcard;

- (NSString *)stringWithMask;

- (NSString *)stringWithPrefix;

- (NSString *)description;

#pragma mark -
#pragma mark Querying Subnet Hosts Count

- (SCUInteger)count;

#pragma mark -
#pragma mark Subnet Address Methods

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

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

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

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

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

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

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

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

#pragma mark -
#pragma mark Subnetting

- (BOOL)isIncludeSubnet:(SCSubnet *)subnet;

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

- (BOOL)isIncludeSubnetWithAddress:(SCIPAddress *)address mask:(SCSubnetMask *)mask;

- (BOOL)isIncludeSubnetWithAddress:(SCIPAddress *)address maskString:(NSString *)mask;

- (BOOL)isIncludeSubnetWithAddress:(SCIPAddress *)address length:(SCUByte)length;

- (BOOL)isIncludeSubnetWithAddress:(SCIPAddress *)address prefix:(NSString *)prefix;

- (BOOL)isIncludeSubnetWithAddress:(SCIPAddress *)address wildcard:(NSString *)wildcard;

- (BOOL)isIncludeSubnetWithAddress:(SCIPAddress *)address count:(SCUInteger)count;

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

- (BOOL)isIncludeSubnetWithString:(NSString *)address mask:(SCSubnetMask *)mask;

- (BOOL)isIncludeSubnetWithString:(NSString *)address maskString:(NSString *)mask;

- (BOOL)isIncludeSubnetWithString:(NSString *)address length:(SCUByte)length;

- (BOOL)isIncludeSubnetWithString:(NSString *)address prefix:(NSString *)prefix;

- (BOOL)isIncludeSubnetWithString:(NSString *)address wildcard:(NSString *)wildcard;

- (BOOL)isIncludeSubnetWithString:(NSString *)address count:(SCUInteger)count;

- (BOOL)isIncludeSubnetWithStartAddress:(SCIPAddress *)start endAddress:(SCIPAddress *)end;

- (BOOL)isIncludeSubnetWithStartString:(NSString *)start endString:(NSString *)end;

- (BOOL)isIncludeSubnets:(NSArray *)subnets;

- (BOOL)isIncludedIntoSubnet:(SCSubnet *)subnet;

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

- (BOOL)isIncludedIntoSubnetWithAddress:(SCIPAddress *)address mask:(SCSubnetMask *)mask;

- (BOOL)isIncludedIntoSubnetWithAddress:(SCIPAddress *)address maskString:(NSString *)mask;

- (BOOL)isIncludedIntoSubnetWithAddress:(SCIPAddress *)address length:(SCUByte)length;

- (BOOL)isIncludedIntoSubnetWithAddress:(SCIPAddress *)address prefix:(NSString *)prefix;

- (BOOL)isIncludedIntoSubnetWithAddress:(SCIPAddress *)address wildcard:(NSString *)wildcard;

- (BOOL)isIncludedIntoSubnetWithAddress:(SCIPAddress *)address count:(SCUInteger)count;

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

- (BOOL)isIncludedIntoSubnetWithString:(NSString *)address mask:(SCSubnetMask *)mask;

- (BOOL)isIncludedIntoSubnetWithString:(NSString *)address maskString:(NSString *)mask;

- (BOOL)isIncludedIntoSubnetWithString:(NSString *)address length:(SCUByte)length;

- (BOOL)isIncludedIntoSubnetWithString:(NSString *)address prefix:(NSString *)prefix;

- (BOOL)isIncludedIntoSubnetWithString:(NSString *)address wildcard:(NSString *)wildcard;

- (BOOL)isIncludedIntoSubnetWithString:(NSString *)address count:(SCUInteger)count;

- (BOOL)isIncludedIntoSubnetWithStartAddress:(SCIPAddress *)start endAddress:(SCIPAddress *)end;

- (BOOL)isIncludedIntoSubnetWithStartString:(NSString *)start endString:(NSString *)end;

- (BOOL)isIncludedIntoSubnets:(NSArray *)subnets;

- (BOOL)isDivided;

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

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

- (BOOL)isDividedWithLength:(SCUByte)length;

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

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

- (BOOL)isDividedWithCount:(SCUInteger)count;

- (BOOL)isDividedWithSubnetsCount:(SCUInteger)count;

- (SCUInteger)subnetsCountWithMask:(SCSubnetMask *)mask;

- (SCUInteger)subnetsCountWithString:(NSString *)mask;

- (SCUInteger)subnetsCountWithLength:(SCUByte)length;

- (SCUInteger)subnetsCountWithPrefix:(NSString *)prefix;

- (SCUInteger)subnetsCountWithWildcard:(NSString *)wildcard;

- (SCUInteger)subnetsCountWithCount:(SCUInteger)count;

- (SCUInteger)maximumSubnets;

- (NSArray *)subnetsWithMask:(SCSubnetMask *)mask;

- (NSArray *)subnetsWithString:(NSString *)mask;

- (NSArray *)subnetsWithLength:(SCUByte)length;

- (NSArray *)subnetsWithPrefix:(NSString *)prefix;

- (NSArray *)subnetsWithWildcard:(NSString *)wildcard;

- (NSArray *)subnetsWithCount:(SCUInteger)count;

- (NSArray *)subnetsWithSubnetsCount:(SCUInteger)count;

- (SCSubnet *)subnetWithMergedSubnet:(SCSubnet *)subnet;

- (SCSubnet *)subnetWithMergedAddress:(SCIPAddress *)address;

- (SCSubnet *)subnetWithMergedAddress:(SCIPAddress *)address mask:(SCSubnetMask *)mask;

- (SCSubnet *)subnetWithMergedAddress:(SCIPAddress *)address maskString:(NSString *)mask;

- (SCSubnet *)subnetWithMergedAddress:(SCIPAddress *)address length:(SCUByte)length;

- (SCSubnet *)subnetWithMergedAddress:(SCIPAddress *)address prefix:(NSString *)prefix;

- (SCSubnet *)subnetWithMergedAddress:(SCIPAddress *)address wildcard:(NSString *)wildcard;

- (SCSubnet *)subnetWithMergedAddress:(SCIPAddress *)address count:(SCUInteger)count;

- (SCSubnet *)subnetWithMergedString:(NSString *)address;

- (SCSubnet *)subnetWithMergedString:(NSString *)address mask:(SCSubnetMask *)mask;

- (SCSubnet *)subnetWithMergedString:(NSString *)address maskString:(NSString *)mask;

- (SCSubnet *)subnetWithMergedString:(NSString *)address length:(SCUByte)length;

- (SCSubnet *)subnetWithMergedString:(NSString *)address prefix:(NSString *)prefix;

- (SCSubnet *)subnetWithMergedString:(NSString *)address wildcard:(NSString *)wildcard;

- (SCSubnet *)subnetWithMergedString:(NSString *)address count:(SCUInteger)count;

- (SCSubnet *)subnetWithMergedSubnets:(NSArray *)subnets;

- (SCSubnet *)subnetWithMergedStartAddress:(SCIPAddress *)start endAddress:(SCIPAddress *)end;

- (SCSubnet *)subnetWithMergedStartString:(NSString *)start endString:(NSString *)end;

- (BOOL)isConnectedWithSubnet:(SCSubnet *)subnet;

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

- (BOOL)isConnectedWithAddress:(SCIPAddress *)address mask:(SCSubnetMask *)mask;

- (BOOL)isConnectedWithAddress:(SCIPAddress *)address maskString:(NSString *)mask;

- (BOOL)isConnectedWithAddress:(SCIPAddress *)address length:(SCUByte)length;

- (BOOL)isConnectedWithAddress:(SCIPAddress *)address prefix:(NSString *)prefix;

- (BOOL)isConnectedWithAddress:(SCIPAddress *)address wildcard:(NSString *)wildcard;

- (BOOL)isConnectedWithAddress:(SCIPAddress *)address count:(SCUInteger)count;

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

- (BOOL)isConnectedWithString:(NSString *)address mask:(SCSubnetMask *)mask;

- (BOOL)isConnectedWithString:(NSString *)address maskString:(NSString *)mask;

- (BOOL)isConnectedWithString:(NSString *)address length:(SCUByte)length;

- (BOOL)isConnectedWithString:(NSString *)address prefix:(NSString *)prefix;

- (BOOL)isConnectedWithString:(NSString *)address wildcard:(NSString *)wildcard;

- (BOOL)isConnectedWithString:(NSString *)address count:(SCUInteger)count;

- (BOOL)isConnectedWithStartAddress:(SCIPAddress *)start endAddress:(SCIPAddress *)end;

- (BOOL)isConnectedWithStartString:(NSString *)start endString:(NSString *)end;

- (BOOL)isConnectedWithSubnets:(NSArray *)subnets;

#pragma mark -
#pragma mark Classfull and Network Methods

- (BOOL)isClassfull;

- (BOOL)isClassless;

- (NSString *)subnetClass;

- (BOOL)isClassA;

- (BOOL)isClassB;

- (BOOL)isClassC;

- (BOOL)isInternet;

- (BOOL)isSerialLink;

@end