SCStreamDelegate.h

Go to the documentation of this file.

//
//  SCStreamDelegate.h
//  scl
//
//  Created by Viacheslav Smolensky on 05.05.12.
//  Copyright (c) 2007 - 2018 by Samond Development Corporation. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <scl/SCDelegate.h>
#import <scl/SCFileStream.h>
#import <scl/SCStream.h>

#pragma mark -
#pragma mark Class Constants

#define SCStreamDelegateClass   @"SCStreamDelegate"


#pragma mark -
#pragma mark Protocol SCStreamDelegate Declaration

@protocol SCStreamDelegate
@optional

#pragma mark -
#pragma mark Handling Stream Errors

- (void)stream:(SCStream *)stream didDetectError:(SCStreamStatus)error;

#pragma mark -
#pragma mark Data Reading Events Handlers

- (void)willReadObjectFromStream:(SCStream *)stream;

- (void)stream:(SCStream *)stream willReadBytes:(SCSize)bytes toBuffer:(void *)buffer;

- (void)stream:(SCStream *)stream didFinishReadingObject:(id<SCStreaming>)object;

- (void)stream:(SCStream *)stream didFinishReadingBytes:(SCSize)bytes toBuffer:(void *)buffer;

#pragma mark -
#pragma mark Data Writing Events Handlers

- (void)stream:(SCStream *)stream willWriteObject:(id<SCStreaming>)object;

- (void)stream:(SCStream *)stream willWriteBytes:(SCSize)bytes fromBuffer:(const void *)buffer;

- (void)stream:(SCStream *)stream didFinishWritingObject:(id<SCStreaming>)object;

- (void)stream:(SCStream *)stream didFinishWritingBytes:(SCSize)bytes fromBuffer:(const void *)buffer;

#pragma mark -
#pragma mark File Stream Opening and Closing Events Handlers

- (void)stream:(SCStream *)stream willOpenWithPath:(NSString *)path mode:(SCFileStreamOpenMode)mode;

- (void)willCloseStream:(SCStream *)stream;

- (void)stream:(SCStream *)stream didFinishOpeningWithPath:(NSString *)path mode:(SCFileStreamOpenMode)mode
  successfully:(BOOL)successfully;

- (void)didFinishClosingStream:(SCStream *)stream;

@end

#pragma mark -
#pragma mark Class SCStreamDelegate Declaration

@interface SCStreamDelegate : SCDelegate <SCStreamDelegate>

#pragma mark -
#pragma mark Handling Stream Errors
- (void)stream:(SCStream *)stream didDetectError:(SCStreamStatus)error;

#pragma mark -
#pragma mark Data Reading Events Handlers
- (void)willReadObjectFromStream:(SCStream *)stream;
- (void)stream:(SCStream *)stream willReadBytes:(SCSize)bytes toBuffer:(void *)buffer;
- (void)stream:(SCStream *)stream didFinishReadingObject:(id<SCStreaming>)object;
- (void)stream:(SCStream *)stream didFinishReadingBytes:(SCSize)bytes toBuffer:(void *)buffer;

#pragma mark -
#pragma mark Data Writing Events Handlers
- (void)stream:(SCStream *)stream willWriteObject:(id<SCStreaming>)object;
- (void)stream:(SCStream *)stream willWriteBytes:(SCSize)bytes fromBuffer:(const void *)buffer;
- (void)stream:(SCStream *)stream didFinishWritingObject:(id<SCStreaming>)object;
- (void)stream:(SCStream *)stream didFinishWritingBytes:(SCSize)bytes fromBuffer:(const void *)buffer;

#pragma mark -
#pragma mark File Stream Opening and Closing Events Handlers
- (void)stream:(SCStream *)stream willOpenWithPath:(NSString *)path mode:(SCFileStreamOpenMode)mode;
- (void)willCloseStream:(SCStream *)stream;
- (void)stream:(SCStream *)stream didFinishOpeningWithPath:(NSString *)path mode:(SCFileStreamOpenMode)mode
  successfully:(BOOL)successfully;
- (void)didFinishClosingStream:(SCStream *)stream;

@end