SCStreamException.h

См. документацию.

//
//  SCStreamException.h
//  scl
//
//  Created by Viacheslav Smolensky on 03.03.12.
//  Copyright (c) 2007 - 2017 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCException.h>

#pragma mark -
#pragma mark Class Constants

#define SCStreamExceptionClass          @"SCStreamException"
#define SCStreamErrorName               @"SCStream"

#pragma mark -
#pragma mark Error ID Constants

#define SCStreamEIDUnspecified          @"SCL-20020"
#define SCStreamEIDNotOpen              @"SCL-20021"
#define SCStreamEIDReadOnly             @"SCL-20022"
#define SCStreamEIDWriteOnly            @"SCL-20023"
#define SCStreamEIDUnknown              @"SCL-20024"
#define SCStreamEIDUnexpected           @"SCL-20025"
#define SCStreamEIDUnsupported          @"SCL-20026"
#define SCStreamEIDIncompleteReading    @"SCL-20027"
#define SCStreamEIDIncompleteWriting    @"SCL-20028"
#define SCStreamEIDOpening              @"SCL-20029"
#define SCStreamEIDRead                 @"SCL-20030"
#define SCStreamEIDWrite                @"SCL-20031"
#define SCStreamEIDNumber               @"SCL-20032"

#pragma mark -
#pragma mark Class Support Types

enum _SCStreamError {
    SCStreamErrorUnspecified        = -20020,
    SCStreamErrorNotOpen            = -20021,
    SCStreamErrorReadOnly           = -20022,
    SCStreamErrorWriteOnly          = -20023,
    SCStreamErrorUnknown            = -20024,
    SCStreamErrorUnexpected         = -20025,
    SCStreamErrorUnsupported        = -20026,
    SCStreamErrorIncompleteReading  = -20027,
    SCStreamErrorIncompleteWriting  = -20028,
    SCStreamErrorOpening            = -20029,
    SCStreamErrorRead               = -20030,
    SCStreamErrorWrite              = -20031,
    SCStreamErrorNumber             = -20032,
};

typedef SCInteger SCStreamError;

@interface SCStreamException : SCException {
    NSString *fStreamName;              // Errneous stream name
    NSString *fUnknown;                 // Unknown class name
    NSString *fUnexpected;              // Unexpected class name
    NSString *fExpected;                // Expected class name
    NSString *fUnsupported;             // Unsupported class name
    SCSize fReadedBytes;                // Number of the readed characters
    SCSize fWritedBytes;                // Number of the writed characters
    SCSize fWaitedBytes;                // Number of the waited characters
    SCInteger fOpenError;               // Stream open error code
    SCInteger fReadError;               // Reading error code
    SCInteger fWriteError;              // Writing error code
    NSString *fNumberType;              // Unsupported NSNumber type code
}
#pragma mark -
#pragma mark Instance Properties

@property (nonatomic, retain, readonly, getter=streamName) NSString *streamName;

@property (retain, readonly, getter=unknown) NSString *unknown;

@property (nonatomic, retain, readonly, getter=unexpected) NSString *unexpected;

@property (nonatomic, retain, readonly, getter=expected) NSString *expected;

@property (retain, readonly, getter=unsupported) NSString *unsupported;

@property (nonatomic, assign, readonly, getter=readedBytes) SCSize readedBytes;

@property (nonatomic, assign, readonly, getter=writedBytes) SCSize writedBytes;

@property (nonatomic, assign, readonly, getter=waitedBytes) SCSize waitedBytes;

@property (nonatomic, assign, readonly, getter=openError) SCInteger openError;

@property (nonatomic, assign, readonly, getter=readError) SCInteger readError;

@property (nonatomic, assign, readonly, getter=writeError) SCInteger writeError;

@property (assign, readonly, getter=numberType) NSString *numberType;

#pragma mark -
#pragma mark Instance Properties
- (NSString *)streamName;
- (NSString *)unknown;
- (NSString *)unexpected;
- (NSString *)expected;
- (NSString *)unsupported;
- (SCSize)readedBytes;
- (SCSize)writedBytes;
- (SCSize)waitedBytes;
- (SCInteger)openError;
- (SCInteger)readError;
- (SCInteger)writeError;
- (NSString *)numberType;

#pragma mark -
#pragma mark Creating and Initializing the Generic Stream Exceptions (SCL-20020)
+ (instancetype)exceptionWithStream:(NSString *)stream
                             reason:(NSString *)reason
                               code:(SCInteger)code
                                eid:(NSString *)eid;
+ (instancetype)exceptionWithReason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
+ (instancetype)exceptionWithStream:(NSString *)stream;
+ (instancetype)exception;
- (instancetype)initWithStream:(NSString *)stream reason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
- (instancetype)initWithReason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
- (instancetype)initWithStreamName:(NSString *)stream;
- (instancetype)init;

#pragma mark -
#pragma mark Creating and Initializing Not Open Stream Exception (SCL-20021)
+ (instancetype)exceptionWithNotOpenStream:(NSString *)stream;
+ (instancetype)exceptionWithNotOpen;
- (instancetype)initWithNotOpenStream:(NSString *)stream;
- (instancetype)initWithNotOpen;

#pragma mark -
#pragma mark Creating and Initializing Read Only Stream Exception (SCL-20022)
+ (instancetype)exceptionWithReadOnlyStream:(NSString *)stream;
+ (instancetype)exceptionWithReadOnly;
- (instancetype)initWithReadOnlyStream:(NSString *)stream;
- (instancetype)initWithReadOnly;

#pragma mark -
#pragma mark Creating and Initializing Write Only Stream Exception (SCL-20023)
+ (instancetype)exceptionWithWriteOnlyStream:(NSString *)stream;
+ (instancetype)exceptionWithWriteOnly;
- (instancetype)initWithWriteOnlyStream:(NSString *)stream;
- (instancetype)initWithWriteOnly;

#pragma mark -
#pragma mark Creating and Initializing Unknown Class Exception (SCL-20024)
+ (instancetype)exceptionWithUnknown:(NSString *)name stream:(NSString *)stream;
+ (instancetype)exceptionWithUnknown:(NSString *)name;
- (instancetype)initWithUnknown:(NSString *)name stream:(NSString *)stream;
- (instancetype)initWithUnknown:(NSString *)name;

#pragma mark -
#pragma mark Creating and Initializing Unexpected Class Exception (SCL-20025)
+ (instancetype)exceptionWithUnexpected:(NSString *)unexpected expected:(NSString *)expected stream:(NSString *)stream;
+ (instancetype)exceptionWithUnexpected:(NSString *)unexpected expected:(NSString *)expected;
- (instancetype)initWithUnexpected:(NSString *)unexpected expected:(NSString *)expected stream:(NSString *)stream;
- (instancetype)initWithUnexpected:(NSString *)unexpected expected:(NSString *)expected;

#pragma mark -
#pragma mark Creating and Initializing Unsupported Class Exception (SCL-20026)
+ (instancetype)exceptionWithUnsupported:(NSString *)name stream:(NSString *)stream;
+ (instancetype)exceptionWithUnsupported:(NSString *)name;
- (instancetype)initWithUnsupported:(NSString *)name stream:(NSString *)stream;
- (instancetype)initWithUnsupported:(NSString *)name;

#pragma mark -
#pragma mark Creating and Initializing Incompleted Operation Exception (SCL-20027 and SCL-20028)
+ (instancetype)exceptionWithReaded:(SCSize)readed waited:(SCSize)waited stream:(NSString *)stream;
+ (instancetype)exceptionWithReaded:(SCSize)readed waited:(SCSize)waited;
+ (instancetype)exceptionWithWrited:(SCSize)writed waited:(SCSize)waited stream:(NSString *)stream;
+ (instancetype)exceptionWithWrited:(SCSize)writed waited:(SCSize)waited;
- (instancetype)initWithReaded:(SCSize)readed waited:(SCSize)waited stream:(NSString *)stream;
- (instancetype)initWithReaded:(SCSize)readed waited:(SCSize)waited;
- (instancetype)initWithWrited:(SCSize)writed waited:(SCSize)waited stream:(NSString *)stream;
- (instancetype)initWithWrited:(SCSize)writed waited:(SCSize)waited;

#pragma mark -
#pragma mark Creating and Initializing Opening Exception (SCL-20029)
+ (instancetype)exceptionWithOpenError:(SCInteger)error stream:(NSString *)stream;
+ (instancetype)exceptionWithOpenError:(SCInteger)error;
- (instancetype)initWithOpenError:(SCInteger)error stream:(NSString *)stream;
- (instancetype)initWithOpenError:(SCInteger)error;

#pragma mark -
#pragma mark Creating and Initializing Reading Exception (SCL-20030)
+ (instancetype)exceptionWithReadError:(SCInteger)error stream:(NSString *)stream;
+ (instancetype)exceptionWithReadError:(SCInteger)error;
- (instancetype)initWithReadError:(SCInteger)error stream:(NSString *)stream;
- (instancetype)initWithReadError:(SCInteger)error;

#pragma mark -
#pragma mark Creating and Initializing Writing Exception (SCL-20031)
+ (instancetype)exceptionWithWriteError:(SCInteger)error stream:(NSString *)stream;
+ (instancetype)exceptionWithWriteError:(SCInteger)error;
- (instancetype)initWithWriteError:(SCInteger)error stream:(NSString *)stream;
- (instancetype)initWithWriteError:(SCInteger)error;

#pragma mark -
#pragma mark Creating and Initializing Number Object Exception (SCL-20032)
+ (instancetype)exceptionWithUnsupportedNumberType:(NSString *)type stream:(NSString *)stream;
+ (instancetype)exceptionWithUnsupportedNumberType:(NSString *)type;
- (instancetype)initWithUnsupportedNumberType:(NSString *)type stream:(NSString *)stream;
- (instancetype)initWithUnsupportedNumberType:(NSString *)type;

@end