SCStreamDelegateObject Class Reference

Protocol SCStreamDelegate implementation class. More...

#import <SCStreamDelegateObject.h>

Inheritance diagram for SCStreamDelegateObject:

List of all members.

Public Member Functions
Stream Error Events
(void)	- stream:didDetectError:
Prior Events Methods
(void)	- willReadObjectFromStream:
(void)	- stream:willWriteObject:
(void)	- stream:willReadBytes:toBuffer:
(void)	- stream:willWriteBytes:fromBuffer:
(void)	- stream:willOpenWithPath:mode:
(void)	- willCloseStream:
(void)	- stream:willSetOffset:whence:
(void)	- willRewindStream:
(void)	- willReadStringFromStream:
(void)	- stream:willWriteString:encoding:
(void)	- stream:willReadStringWithEncoding:max:
Completed Events Methods
(void)	- stream:didFinishReadingObject:
(void)	- stream:didFinishWritingObject:
(void)	- stream:didFinishReadingBytes:toBuffer:
(void)	- stream:didFinishWritingBytes:fromBuffer:
(void)	- didFinishOpeningStream:
(void)	- stream:didFinishOpeningWithPath:mode:successfully:
(void)	- didFinishClosingStream:
(void)	- stream:didFinishSettingOffset:whence:
(void)	- didFinishRewindingStream:
(void)	- stream:didFinishReadingString:
(void)	- stream:didFinishWritingString:encoding:
(void)	- stream:didFinishReadingString:encoding:max:

---

Detailed Description

Protocol SCStreamDelegate implementation class.

Class implements the protocol SCStreamDelegate.
Class was introduced in version 1.1.3.

---

Member Function Documentation

- (void) didFinishClosingStream:

(SCStream *)

stream

Tells the delegate that the stream finished the closing.

Parameters:

stream

- stream instance

Reimplemented from <SCStreamDelegate>.

- (void) didFinishOpeningStream:

(SCStream *)

stream

Tells the delegate that the stream finished the opening operation.

Parameters:

stream

- stream instance

Reimplemented from <SCStreamDelegate>.

- (void) didFinishRewindingStream:

(SCFileStream *)

stream

Tells the delegate that the stream is finished the rewind operation.

Parameters:

stream

- stream instance

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream detects the error.

Parameters:

stream	- stream instance
error	- detected error code

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream finishes the opening with the specified path and mode.

Parameters:

stream	- stream instance
path	- stream path
mode	- stream mode
successfully	- YES if opening is successfully, otherwise NO

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream finishes the reading bytes into the buffer.

Parameters:

stream	- stream instance
bytes	- count of actually readed bytes
buffer	- pointer to the received data buffer

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream finishes reading class instance.

Parameters:

stream	- stream instance
object	- readed object

Reimplemented from <SCStreamDelegate>.

- (void) stream:		(SCStream *)	stream
didFinishReadingString:		(NSString *)	string

Tells the delegate that the stream finishes the string reading.

Parameters:

stream	- stream instance
string	- readed string

Reimplemented from <SCStreamDelegate>.

- (void) stream:		(SCStream *)	stream
didFinishReadingString:		(NSString *)	string
encoding:		(NSStringEncoding)	encoding
max:		(SCUInteger)	max

Tells the delegate that the stream is finished reading the string using the encoding and maximum size.

Parameters:

stream	- stream instance
string	- readed string
encoding	- string encoding
max	- maximum length

Reimplemented from <SCStreamDelegate>.

- (void) stream:		(SCFileStream *)	stream
didFinishSettingOffset:		(SCLong)	offset
whence:		(SCFileStreamOffsetWhence)	whence

Tells the delegate that the stream is finished the offset operation.

Parameters:

stream	- stream instance
offset	- stream offset
whence	- offset whence

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream finishes the writing bytes from the buffer.

Parameters:

stream	- stream instance
bytes	- count of actually writed bytes
buffer	- pointer to the sended data buffer

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream finishes writing the class instance.

Parameters:

stream	- stream instance
object	- writed object

Reimplemented from <SCStreamDelegate>.

- (void) stream:		(SCStream *)	stream
didFinishWritingString:		(NSString *)	string
encoding:		(NSStringEncoding)	encoding

Tells the delegate that the stream finishes the string writing.

Parameters:

stream	- stream instance
string	- writed string
encoding	- string encoding

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream is about to open using the specified path and mode.

Parameters:

stream	- stream instance
path	- stream path
mode	- stream mode

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream is about to read bytes into the buffer.

Parameters:

stream	- stream instance
bytes	- count of bytes for reading from the stream
buffer	- pointer to the receiving data buffer

Reimplemented from <SCStreamDelegate>.

- (void) stream:		(SCStream *)	stream
willReadStringWithEncoding:		(NSStringEncoding)	encoding
max:		(SCUInteger)	max

Tells the delegate that the stream is about to read the string using the specified encoding and maximum length.

Parameters:

stream	- stream instance
encoding	- string encoding
max	- maximum length

Reimplemented from <SCStreamDelegate>.

- (void) stream:		(SCFileStream *)	stream
willSetOffset:		(SCLong)	offset
whence:		(SCFileStreamOffsetWhence)	whence

Tells the delegate that the stream is about to change offset.

Parameters:

stream	- stream instance
offset	- stream offset
whence	- offset whence

Reimplemented from <SCStreamDelegate>.

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

Tells the delegate that the stream is about to write bytes from the buffer.

Parameters:

stream	- stream instance
bytes	- count of bytes for writing to the stream
buffer	- pointer to the sending data buffer

Reimplemented from <SCStreamDelegate>.

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

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

Parameters:

stream	- stream instance
object	- writed object

Reimplemented from <SCStreamDelegate>.

- (void) stream:		(SCStream *)	stream
willWriteString:		(NSString *)	string
encoding:		(NSStringEncoding)	encoding

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

Parameters:

stream	- stream instance
string	- writed string
encoding	- string encoding

Reimplemented from <SCStreamDelegate>.

- (void) willCloseStream:

(SCStream *)

stream

Tells the delegate that the stream is about to close.

Parameters:

stream

- stream instance

Reimplemented from <SCStreamDelegate>.

- (void) willReadObjectFromStream:

(SCStream *)

stream

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

Parameters:

stream

- stream instance

Reimplemented from <SCStreamDelegate>.

- (void) willReadStringFromStream:

(SCStream *)

stream

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

Parameters:

stream

- stream instance

Reimplemented from <SCStreamDelegate>.

- (void) willRewindStream:

(SCFileStream *)

stream

Tells the delegate that the stream is about to rewind.

Parameters:

stream

- stream instance

Reimplemented from <SCStreamDelegate>.

---

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

• SCStreamDelegateObject.h
• SCStreamDelegateObject.m