<SCStreaming> Protocol Reference

Streams communications protocol. More...

#import <SCStreaming.h>

Inheritance diagram for <SCStreaming>:

Instance Methods
(id)	- initWithStream:
(id)	- initWithFileStream:
(void)	- writeToStream:
(void)	- writeToFileStream:
(void)	- appendToFileStream:
(NSString *)	- className

Detailed Description

Streams communications protocol.

Since

version 1.1.3

Declares methods for communicate between classes and streams. Defined by the protocol methods support based operations such are writing class instances into the stream and reading and initializing class instances from the stream.

Method Documentation

- (void) appendToFileStream:

(NSString *)

path

Appends the class instance data into the file stream with the specified path.

Parameters

path	- the path to the output file stream

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented in NSString(SCString), NSOrderedSet(SCNSOrderedSet), NSArray(SCNSArray), NSDictionary(SCNSDictionary), NSSet(SCNSSet), NSNull(SCNull), NSDate(SCDate), NSNumber(SCNumber), and SCObject.

- (NSString *) className

Returns the receving instance class name.

Returns

Class name

Reimplemented in SCObject.

- (id) initWithFileStream:

(NSString *)

path

Initializes the class instance using the data from the file stream with the specified path.

Parameters

path	- the path to the source file stream

Returns

A newly initialized class instance

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented in NSString(SCString), NSOrderedSet(SCNSOrderedSet), NSArray(SCNSArray), NSDictionary(SCNSDictionary), NSSet(SCNSSet), NSNull(SCNull), NSDate(SCDate), NSNumber(SCNumber), and SCObject.

- (id) initWithStream:

(SCStream *)

stream

Initializes the class instance using the data from the specified stream.

Parameters

stream

- the source stream

Returns

A newly initialized class instance

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented in NSString(SCString), NSOrderedSet(SCNSOrderedSet), NSArray(SCNSArray), NSDictionary(SCNSDictionary), NSSet(SCNSSet), NSNull(SCNull), NSDate(SCDate), NSNumber(SCNumber), and SCObject.

- (void) writeToFileStream:

(NSString *)

path

Writes the class instance data into the file stream with the specified path.

Parameters

path	- the path to the output file stream

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented in NSString(SCString), NSOrderedSet(SCNSOrderedSet), NSArray(SCNSArray), NSDictionary(SCNSDictionary), NSSet(SCNSSet), NSNull(SCNull), NSDate(SCDate), NSNumber(SCNumber), and SCObject.

- (void) writeToStream:

(SCStream *)

stream

Writes the class instance data into the specified stream.

Parameters

stream

- the output stream

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented in NSString(SCString), NSOrderedSet(SCNSOrderedSet), NSArray(SCNSArray), NSDictionary(SCNSDictionary), NSSet(SCNSSet), NSNull(SCNull), NSDate(SCDate), NSNumber(SCNumber), and SCObject.

---

The documentation for this protocol was generated from the following file:

• SCStreaming.h