SCNetException.h

Go to the documentation of this file.

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

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

#define SCNetExceptionClass @"SCNetException" ///< SCNetException class name

#pragma mark Exception supporting types

enum _SCNetError {
    SCNetErrorUnspecified       = 0,    
    SCNetErrorSubnetMask        = 1,    
        SCNetErrorWildcardMask  = 2,    
        SCNetErrorSubnetPrefix  = 3,    
    SCNetErrorIPAddress     = 4     
};

typedef enum _SCNetError SCNetError;

#pragma mark -
#pragma mark Exception name constant

#define SCNetErrorName  @"SCNet"    ///< Name of exception

#pragma mark -

@interface SCNetException : SCException {
    SCNetError fType;       // Network exception type
    NSString *fData;        // Network exception data
    SCSystemError fError;   // System error code
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// Network exception type property
@property (nonatomic, assign, readonly, getter=type) SCNetError type;
// Network exception data property
@property (nonatomic, retain, readonly, getter=data) NSString *data;
// System error code property
@property (nonatomic, assign, readonly, getter=error) SCSystemError error;
#endif

#pragma mark -
#pragma mark Creating and Initializing Generic Network Exception

+ (SCNetException *)exception;

+ (SCNetException *)exceptionWithReason:(NSString *)reason;

+ (SCNetException *)exceptionWithType:(SCNetError)type reason:(NSString *)reason;

+ (SCNetException *)exceptionWithType:(SCNetError)type
                                 data:(NSString *)data
                                error:(SCSystemError)error;

+ (SCNetException *)exceptionWithType:(SCNetError)type data:(NSString *)data;

+ (SCNetException *)exceptionWithType:(SCNetError)type;

- (id)init;

- (id)initWithReason:(NSString *)reason;

- (id)initWithType:(SCNetError)type reason:(NSString *)reason;

- (id)initWithType:(SCNetError)type data:(NSString *)data error:(SCSystemError)error;

- (id)initWithType:(SCNetError)type data:(NSString *)data;

- (id)initWithType:(SCNetError)type;

#pragma mark -
#pragma mark Creating and Initializing Subnets Related Exception

+ (SCNetException *)exceptionWithEmptySubnetMask;

+ (SCNetException *)exceptionWithSubnetMask:(NSString *)mask;

+ (SCNetException *)exceptionWithUncontinuouslySubnetMask:(NSString *)mask;

+ (SCNetException *)exceptionWithEmptyWildcardMask;

+ (SCNetException *)exceptionWithWildcardMask:(NSString *)wildcard;

+ (SCNetException *)exceptionWithUncontinuouslyWildcardMask:(NSString *)wildcard;

+ (SCNetException *)exceptionWithSubnetHostsCount:(SCUInteger)count;

+ (SCNetException *)exceptionWithEmptySourceSubnetMask;

+ (SCNetException *)exceptionWithHostSubnet;

+ (SCNetException *)exceptionWithHostWildcard;

+ (SCNetException *)exceptionWithEmptySubnet;

+ (SCNetException *)exceptionWithStartAddressLess;

+ (SCNetException *)exceptionWithEmptySubnetsArray;

- (id)initWithEmptySubnetMask;

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

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

- (id)initWithEmptyWildcardMask;

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

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

- (id)initWithSubnetHostsCount:(SCUInteger)count;

- (id)initWithEmptySourceSubnetMask;

- (id)initWithHostSubnet;

- (id)initWithHostWildcard;

- (id)initWithEmptySubnet;

- (id)initWithStartAddressLess;

- (id)initWithEmptySubnetsArray;

#pragma mark -
#pragma mark Creating and Initializing Subnet Prefixes Related Exception

+ (SCNetException *)exceptionWithSubnetPrefix:(NSString *)prefix;

+ (SCNetException *)exceptionWithPrefixLength:(SCUByte)length;

+ (SCNetException *)exceptionWithEmptySubnetPrefix;

+ (SCNetException *)exceptionWithHostPrefixLength;

+ (SCNetException *)exceptionWithHostSubnetPrefix;

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

- (id)initWithPrefixLength:(SCUByte)length;

- (id)initWithEmptySubnetPrefix;

- (id)initWithHostPrefixLength;

- (id)initWithHostSubnetPrefix;

#pragma mark -
#pragma mark Creating and Initializing IP Addresses Related Exception

+ (SCNetException *)exceptionWithAddress:(NSString *)address;

+ (SCNetException *)exceptionWithEmptyAddress;

+ (SCNetException *)exceptionWithFirstOctet:(NSString *)octet;

+ (SCNetException *)exceptionWithRawAddress:(SCUInteger)raw;

+ (SCNetException *)exceptionWithEmptySourceAddress;

+ (SCNetException *)exceptionWithSubnetAddress:(NSString *)address;

+ (SCNetException *)exceptionWithEmptyStartAddress;

+ (SCNetException *)exceptionWithEmptyEndAddress;

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

- (id)initWithEmptyAddress;

- (id)initWithFirstOctet:(NSString *)octet;

- (id)initWithRawAddress:(SCUInteger)raw;

- (id)initWithEmptySourceAddress;

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

- (id)initWithEmptyStartAddress;

- (id)initWithEmptyEndAddress;

#pragma mark -
#pragma mark Querying Exception Properties

- (SCNetError)type;

- (NSString *)data;

- (SCSystemError)error;

- (void)setType:(SCNetError)type;

- (void)setData:(NSString *)data;

- (void)setError:(SCSystemError)error;

@end