SCStandardInputStream Class Reference

Standard input (stdin) stream class. More...

#import <SCStandardInputStream.h>

Inheritance diagram for SCStandardInputStream:

List of all members.

Public Member Functions
Seeking Stream
(BOOL)	- eof
Reading Strings
(NSString *)	- readStringWithEncoding:max:
(NSString *)	- readStringWithEncoding:
(NSString *)	- readStringWithMax:
(NSString *)	- readString
Creating and Initializing Stream
(SCStandardInputStream *)	+ stdinStream
(SCStandardInputStream *)	+ stdinStreamWithDelegate:
(id)	- init
(id)	- initWithDelegate:

---

Detailed Description

Standard input (stdin) stream class.

Class is a concrete subclass of SCStream with support of input from the stdin.
Class was introduced in version 1.1.3.

---

Member Function Documentation

- (BOOL) eof

Determines end of stream flag.

Returns:

YES if end of stream detected, otherwise NO

Reimplemented from SCStream.

- (id) init

Initializes the stdin stream.

Returns:

A newly initialized stream

Reimplemented from SCStream.

- (id) initWithDelegate:

(id<SCStreamDelegate>)

delegate

Initializes the stdin stream using the specified delegate object.

Parameters:

delegate

- delegate object

Returns:

A newly initialized stream

- (NSString *) readString

Returns the string readed by using the UTF-8 encoding.

Returns:

String or nul if error or end of stream detected

Exceptions:

SCStreamException	- stream operation error detected
SCSystemException	- system error detected

Reimplemented from SCStream.

- (NSString *) readStringWithEncoding:

(NSStringEncoding)

encoding

Returns the string readed by using the specified encoding.

Parameters:

encoding

- string encoding

Returns:

String or nul if error or end of stream detected

Exceptions:

SCStreamException	- stream operation error detected
SCSystemException	- system error detected

Reimplemented from SCStream.

- (NSString *) readStringWithEncoding:		(NSStringEncoding)	encoding
max:		(SCUInteger)	max

Returns the string with the specified max length and readed by using the specified encoding.

Parameters:

encoding	- string encoding
max	- max length

Returns:

String or nul if error or end of stream detected

Exceptions:

SCStreamException	- stream operation error detected
SCSystemException	- system error detected

Reimplemented from SCStream.

- (NSString *) readStringWithMax:

(SCUInteger)

max

Returns the string with the specified max length and readed by using the UTF-8 encoding.

Parameters:

max	- max length

Returns:

String or nul if error or end of stream detected

Exceptions:

SCStreamException	- stream operation error detected
SCSystemException	- system error detected

Reimplemented from SCStream.

+ (SCStandardInputStream *) stdinStream

Returns the stdin stream.

Returns:

Standard input stream

+ (SCStandardInputStream *) stdinStreamWithDelegate:

(id<SCStreamDelegate>)

delegate

Returns the stdin stream opening by using the specified delegate object.

Parameters:

delegate

- delegate object

Returns:

Standard input stream

---

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

• SCStandardInputStream.h
• SCStandardInputStream.m