SCSubnetMask.h

Go to the documentation of this file.

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

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

#define SCSubnetMaskClass @"SCSubnetMask" ///< SCSubnetMask class name

#pragma mark -
#pragma mark Predefined subnet mask strings

#define SC_SUBNET_MASK_CLASS_A    @"255.0.0.0"          ///< Class A default subnet mask
#define SC_SUBNET_MASK_CLASS_B    @"255.255.0.0"        ///< Class B default subnet mask
#define SC_SUBNET_MASK_CLASS_C    @"255.255.255.0"      ///< Class C default subnet mask
#define SC_SUBNET_MASK_GLOBAL     @"0.0.0.0"            ///< All internet subnet mask
#define SC_SUBNET_MASK_HOST       @"255.255.255.255"    ///< Host subnet mask
#define SC_SUBNET_MASK_LINK       @"255.255.255.252"    ///< Serial link subnet mask

#pragma mark -

@interface SCSubnetMask : SCNetObject {
        SCUInteger fMask; // The internal representation of the subnet mask
}

#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// Subnet mask text representation property
@property (nonatomic, retain, getter=mask, setter=setMask:) NSString *mask;
// Subnet prefix length property
@property (nonatomic, getter=length, setter=setLength:) SCUByte length;
// Subnet prefix property
@property (nonatomic, retain, getter=prefix, setter=setPrefix:) NSString *prefix;
// Subnet wildcard mask property
@property (nonatomic, retain, getter=wildcard, setter=setWildcard:) NSString *wildcard;
// Subnet hosts count property
@property (nonatomic, getter=hostsCount, setter=setCount:) SCUInteger count;
// Subnet mask internal representation read only property
@property (nonatomic, readonly, getter=raw) SCUInteger raw;
#endif

#pragma mark -
#pragma mark Creating Subnet Mask

+ (SCSubnetMask *)emptyMask;

+ (SCSubnetMask *)maskWithString:(NSString *)mask;

+ (SCSubnetMask *)maskWithPrefixLength:(SCUByte)length;

+ (SCSubnetMask *)maskWithPrefix:(NSString *)prefix;

+ (SCSubnetMask *)maskWithWildcard:(NSString *)wildcard;

+ (SCSubnetMask *)maskWithCount:(SCUInteger)count;

+ (SCSubnetMask *)maskWithMask:(SCSubnetMask *)mask;

+ (SCSubnetMask *)maskWithClassA;

+ (SCSubnetMask *)maskWithClassB;

+ (SCSubnetMask *)maskWithClassC;

+ (SCSubnetMask *)maskWithGlobal;

+ (SCSubnetMask *)maskWithHost;

+ (SCSubnetMask *)maskWithSerialLink;

+ (SCSubnetMask *)maskWithDataDictionary:(NSDictionary *)dictionary;

+ (SCSubnetMask *)maskWithDataDictionaryFromFile:(NSString *)path;

+ (SCSubnetMask *)maskWithCoder:(NSCoder *)coder;

+ (SCSubnetMask *)maskWithContentsOfSerializedFile:(NSString *)path;

+ (SCSubnetMask *)maskWithStream:(SCStream *)stream;

+ (SCSubnetMask *)maskWithFileStream:(NSString *)path;

#pragma mark -
#pragma mark Initializing Subnet mask

- (id)init;

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

- (id)initWithPrefixLength:(SCUByte)length;

- (id)initWithPrefix:(NSString *)prefix;

- (id)initWithWildcard:(NSString *)wildcard;

- (id)initWithCount:(SCUInteger)count;

- (id)initWithMask:(SCSubnetMask *)mask;

- (id)initWithClassA;

- (id)initWithClassB;

- (id)initWithClassC;

- (id)initWithGlobal;

- (id)initWithHost;

- (id)initWithSerialLink;

#pragma mark -
#pragma mark Changing Subnet Mask

- (void)setMask:(NSString *)mask;

- (void)setLength:(SCUByte)length;

- (void)setPrefix:(NSString *)prefix;

- (void)setWildcard:(NSString *)wildcard;

- (void)setCount:(SCUInteger)count;

- (void)copyMask:(SCSubnetMask *)mask;

#pragma mark -
#pragma mark Querying Subnet Mask

- (SCUInteger)raw;

- (NSString *)mask;

- (NSString *)description;

- (SCUByte)length;

- (NSString *)prefix;

- (NSString *)wildcard;

- (SCUInteger)hostsCount;

#pragma mark -
#pragma mark Checking Subnet Mask

- (BOOL)isHostMask;

- (BOOL)isGlobalMask;

- (BOOL)isRegularMask;

- (BOOL)isSerialLink;

- (BOOL)isClassA;

- (BOOL)isClassB;

- (BOOL)isClassC;

- (BOOL)isClassfull;

#pragma mark -
#pragma mark Comparing Subnet Masks

- (BOOL)isEqual:(id)mask;

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

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

- (BOOL)isEqualToLength:(SCUByte)length;

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

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

#pragma mark -
#pragma mark Querying Hosts Count

+ (SCUInteger)hostsClassA;

+ (SCUInteger)hostsClassB;

+ (SCUInteger)hostsClassC;

+ (SCUInteger)hostsSerialLink;

@end