SCStreamException.h

Go to the documentation of this file.

//
//  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 Константы класса

#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 Типы поддержки класса

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;              // Название потока
    NSString *fUnknown;                 // Название неизвестного класса
    NSString *fUnexpected;              // Имя неожиданного класса
    NSString *fExpected;                // Имя ожидавшегося класса
    NSString *fUnsupported;             // Имя неподдерживаемого класса
    SCUInteger fReadedBytes;            // Количество считанных символов
    SCUInteger fWritedBytes;            // Количество записанных символов
    SCUInteger fWaitedBytes;            // Количество ожидавшихся символов
    SCInteger fOpenError;               // Ошибка открытия потока
    SCInteger fReadError;               // Код ошибки чтения
    SCInteger fWriteError;              // Код ошибки записи
    NSString *fNumberType;              // Неподдерживаемый тип числового объекта
}
#pragma mark -
#pragma mark Свойства экземпляра класса

@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) SCUInteger readedBytes;

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

@property (nonatomic, assign, readonly, getter=waitedBytes) SCUInteger 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 Доступ к свойствам экземпляра класса
- (NSString *)streamName;
- (NSString *)unknown;
- (NSString *)unexpected;
- (NSString *)expected;
- (NSString *)unsupported;
- (SCUInteger)readedBytes;
- (SCUInteger)writedBytes;
- (SCUInteger)waitedBytes;
- (SCInteger)openError;
- (SCInteger)readError;
- (SCInteger)writeError;
- (NSString *)numberType;

#pragma mark -
#pragma mark Создание и инициализация общих видов исключительных ситуаций
+ (SCStreamException *)exceptionWithStream:(NSString *)stream
                                    reason:(NSString *)reason
                                      code:(SCInteger)code
                                       eid:(NSString *)eid;
+ (SCStreamException *)exceptionWithReason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
+ (SCStreamException *)exceptionWithStream:(NSString *)stream;
+ (SCStreamException *)exception;
- (id)initWithStream:(NSString *)stream reason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
- (id)initWithReason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
- (id)initWithStream:(NSString *)stream;
- (id)init;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации неоткрытого потока
+ (SCStreamException *)exceptionWithNotOpenStream:(NSString *)stream;
+ (SCStreamException *)exceptionWithNotOpen;
- (id)initWithNotOpenStream:(NSString *)stream;
- (id)initWithNotOpen;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации записи в поток в режиме только для чтения
+ (SCStreamException *)exceptionWithReadOnlyStream:(NSString *)stream;
+ (SCStreamException *)exceptionWithReadOnly;
- (id)initWithReadOnlyStream:(NSString *)stream;
- (id)initWithReadOnly;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации чтения из потока в режиме только для записи
+ (SCStreamException *)exceptionWithWriteOnlyStream:(NSString *)stream;
+ (SCStreamException *)exceptionWithWriteOnly;
- (id)initWithWriteOnlyStream:(NSString *)stream;
- (id)initWithWriteOnly;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации неизвестного класса
+ (SCStreamException *)exceptionWithUnknown:(NSString *)name stream:(NSString *)stream;
+ (SCStreamException *)exceptionWithUnknown:(NSString *)name;
- (id)initWithUnknown:(NSString *)name stream:(NSString *)stream;
- (id)initWithUnknown:(NSString *)name;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации неожиданного класса
+ (SCStreamException *)exceptionWithUnexpected:(NSString *)unexpected
                                      expected:(NSString *)expected
                                        stream:(NSString *)stream;
+ (SCStreamException *)exceptionWithUnexpected:(NSString *)unexpected expected:(NSString *)expected;
- (id)initWithUnexpected:(NSString *)unexpected expected:(NSString *)expected stream:(NSString *)stream;
- (id)initWithUnexpected:(NSString *)unexpected expected:(NSString *)expected;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации неподдерживаемого класса
+ (SCStreamException *)exceptionWithUnsupported:(NSString *)name stream:(NSString *)stream;
+ (SCStreamException *)exceptionWithUnsupported:(NSString *)name;
- (id)initWithUnsupported:(NSString *)name stream:(NSString *)stream;
- (id)initWithUnsupported:(NSString *)name;

#pragma mark -
#pragma mark Создание и инициализация исключительных ситуаций незавершенных операций
+ (SCStreamException *)exceptionWithReaded:(SCUInteger)readed waited:(SCUInteger)waited stream:(NSString *)stream;
+ (SCStreamException *)exceptionWithReaded:(SCUInteger)readed waited:(SCUInteger)waited;
+ (SCStreamException *)exceptionWithWrited:(SCUInteger)writed waited:(SCUInteger)waited stream:(NSString *)stream;
+ (SCStreamException *)exceptionWithWrited:(SCUInteger)writed waited:(SCUInteger)waited;
- (id)initWithReaded:(SCUInteger)readed waited:(SCUInteger)waited stream:(NSString *)stream;
- (id)initWithReaded:(SCUInteger)readed waited:(SCUInteger)waited;
- (id)initWithWrited:(SCUInteger)writed waited:(SCUInteger)waited stream:(NSString *)stream;
- (id)initWithWrited:(SCUInteger)writed waited:(SCUInteger)waited;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации при открытии потока
+ (SCStreamException *)exceptionWithOpenError:(SCInteger)error stream:(NSString *)stream;
+ (SCStreamException *)exceptionWithOpenError:(SCInteger)error;
- (id)initWithOpenError:(SCInteger)error stream:(NSString *)stream;
- (id)initWithOpenError:(SCInteger)error;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации ошибки чтения потока
+ (SCStreamException *)exceptionWithReadError:(SCInteger)error stream:(NSString *)stream;
+ (SCStreamException *)exceptionWithReadError:(SCInteger)error;
- (id)initWithReadError:(SCInteger)error stream:(NSString *)stream;
- (id)initWithReadError:(SCInteger)error;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации ошибки записи в поток
+ (SCStreamException *)exceptionWithWriteError:(SCInteger)error stream:(NSString *)stream;
+ (SCStreamException *)exceptionWithWriteError:(SCInteger)error;
- (id)initWithWriteError:(SCInteger)error stream:(NSString *)stream;
- (id)initWithWriteError:(SCInteger)error;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации числового объекта
+ (SCStreamException *)exceptionWithUnsupportedNumberType:(NSString *)type stream:(NSString *)stream;
+ (SCStreamException *)exceptionWithUnsupportedNumberType:(NSString *)type;
- (id)initWithUnsupportedNumberType:(NSString *)type stream:(NSString *)stream;
- (id)initWithUnsupportedNumberType:(NSString *)type;

@end