InputStream.h

This HTML document was auto-generated from InputStream.h

Interface: InputStream

/*****************************************************************
Interface: InputStream
Desc:
An interface for reading bytes from a byte stream
Notes:
*****************************************************************/

Method: InputStream::close

//=========================================================================
// Method:	close
// Desc:	Close the input stream
// 
// Notes:	
//=========================================================================

C++ Signature

void
InputStream::close(
);


Method: InputStream::read

//=========================================================================
// Method:	read
// Desc:	read a single byte from the stream
// 
// Notes:	
//			returns -1 when EOF reached
//=========================================================================

C++ Signature

int
InputStream::read(
);


Method: InputStream::read

//=========================================================================
// Method:	read
// Desc:	read multiple bytes from the stream
// 
// Notes:
//			may return few than len bytes if EOF reached
//=========================================================================

C++ Signature

int
InputStream::read(
	unsigned char * b,                              //buffer to contain bytes read
	int off,                                        //offset into b
	int len                                         //number of bytes to read
);


Method: InputStream::skip

//=========================================================================
// Method:	skip
// Desc:	skip n bytes without reading
// 
// Notes:
//			may return a value less than n if n would skip beyond EOF
//=========================================================================

C++ Signature

long
InputStream::skip(
	long n                                          //number of bytes to skip
);


Method: InputStream::markSupported

//=========================================================================
// Method:	markSupported
// Desc:	return non-zero if mark()/reset() supported
// 
// Notes:
//
//=========================================================================

C++ Signature

int
InputStream::markSupported(
);


Method: InputStream::mark

//=========================================================================
// Method:	mark
// Desc:	if mark()/reset() are supported, mark current location in
//			stream and remember all bytes read until reset is called.
// 
// Notes:
//			if more than readlimit bytes are read then mark can become
//			invalid
//=========================================================================

C++ Signature

int
InputStream::mark(
	int readlimit                                   //max bytes to allow before mark is invalidated
);


Method: InputStream::reset

//=========================================================================
// Method:	reset
// Desc:	if mark()/reset() are supported, return to marked location in
//			input stream
// 
// Notes:
//			returns 0 if not marked, mark is invalid, or mark not supported
//=========================================================================
//++
//=========================================================================
// Method:	destroy
// Desc:	destroy the instance implementing InputStream
// 
// Notes:
//=========================================================================

C++ Signature

int
InputStream::reset(
);