SCStreamDelegate Class Reference

Streams events handling class. More...

#import <SCStreamDelegate.h>

Inheritance diagram for SCStreamDelegate:

Handling Stream Errors
(void)	- stream:didDetectError:

Data Reading Events Handlers
(void)	- willReadObjectFromStream:
(void)	- stream:willReadBytes:toBuffer:
(void)	- stream:didFinishReadingObject:
(void)	- stream:didFinishReadingBytes:toBuffer:

Data Writing Events Handlers
(void)	- stream:willWriteObject:
(void)	- stream:willWriteBytes:fromBuffer:
(void)	- stream:didFinishWritingObject:
(void)	- stream:didFinishWritingBytes:fromBuffer:

File Stream Opening and Closing Events Handlers
(void)	- stream:willOpenWithPath:mode:
(void)	- willCloseStream:
(void)	- stream:didFinishOpeningWithPath:mode:successfully:
(void)	- didFinishClosingStream:

Additional Inherited Members
Instance Methods inherited from SCObject
(instancetype)	- initWithCoder:
(instancetype)	- initWithContentsOfSerializedFile:
(void)	- encodeWithCoder:
(BOOL)	- writeContentsToSerializedFile:
(instancetype)	- initWithDataDictionary:
(instancetype)	- initWithDataDictionaryFromFile:
(void)	- writeToDataDictionary:
(void)	- writeToDataDictionaryFile:atomically:
(void)	- writeToDataDictionaryFile:
(NSDictionary *)	- dataDictionary
(instancetype)	- initWithStream:
(instancetype)	- initWithFileStream:
(void)	- writeToStream:
(void)	- writeToFileStream:
(void)	- appendToFileStream:
(id)	- copyObject
(SCComparisonResult)	- compareWithObject:
(BOOL)	- isEqual:
(instancetype)	- initWithData:
(instancetype)	- initWithDataWrapper:
(instancetype)	- initWithContentsOfFile:
(instancetype)	- initWithContentsOfURL:
(instancetype)	- initWithContentsOfURLString:
(void)	- writeToData:
(BOOL)	- writeToFile:
(BOOL)	- writeToURL:
(BOOL)	- writeToURLString:
(NSData *)	- data
Instance Methods inherited from <SCStreamDelegate>
Properties inherited from SCObject
NSString *	className

Detailed Description

Streams events handling class.

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Since

version 1.1.3

Implements the methods which are declared in the SCStreamDelegate protocol.

Method Documentation

- (void) didFinishClosingStream:

(SCStream *)

stream

Tells the delegate that the stream instance is finishing the closing the file stream.

Parameters

stream

- the stream instance

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream detects the specified stream error.

Parameters

stream	- the erroneous stream
error	- the detected stream error

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream instance is finishing the opening the file stream.

Parameters

stream	- the stream instance
path	- the path of the file stream
mode	- the stream opening mode
successfully	- YES if the opening operation is successfully comlited, otherwise NO

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream is finishing the reading the data.

Parameters

stream	- the stream instance
bytes	- the number of the actually read bytes from the stream
buffer	- the pointer to the data which will be readed from the stream

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream is finishing the reading the object.

Parameters

stream	- the stream instance
object	- the object, which will be readed from the stream

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream is finishing the writing data.

Parameters

stream	- the stream instance
bytes	- the number of the actually writed bytes
buffer	- the pointer to the buffer with the data which will be writed into the stream

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream is finishing the writing the object.

Parameters

stream	- the stream instance
object	- the object which will be writed into the stream

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream instance is about to open the file stream with the specified path and opening mode.

Parameters

stream	- the stream instance
path	- the path to the file stream
mode	- the file stream opening mode

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream is about to read the data.

Parameters

stream	- the stream instance
bytes	- the number of the bytes to read from the stream
buffer	- the pointer to the reading buffer

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream is about to write the data.

Parameters

stream	- the stream instance
bytes	- the number of bytes to writing to the stream
buffer	- the pointer to the buffer with data to writing to the stream

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream is about to write the specified object.

Parameters

stream	- the stream instance
object	- the object to write to the stream

Reimplemented from <SCStreamDelegate>.

- (void) willCloseStream:

(SCStream *)

stream

Tells the delegate that the stream instance is about to close the file stream.

Parameters

stream

- the stream instance

Reimplemented from <SCStreamDelegate>.

- (void) willReadObjectFromStream:

(SCStream *)

stream

Tells the delegate that the stream is about to read the object.

Parameters

stream

- the stream instance

Reimplemented from <SCStreamDelegate>.

---

The documentation for this class was generated from the following files:

• SCStreamDelegate.h
• SCStreamDelegate.m