Tamir.Streams.CombinedStream Class Reference

Summary description for CombinedStream. More...

List of all members.

Public Member Functions

CombinedStream (Stream inputStream, Stream outputStream)

override int Read (byte[] buffer, int offset, int count)

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

virtual int Read (byte[] buffer)

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

override int ReadByte ()

Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.

override void WriteByte (byte value)

Writes a byte to the current position in the stream and advances the position within the stream by one byte.

override void Write (byte[] buffer, int offset, int count)

Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

virtual void Write (byte[] buffer)

Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

override void Close ()

Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.

override void Flush ()

Clears all buffers for this stream and causes any buffered data to be written to the underlying device.

override void SetLength (long value)

This method has no effect on the Stream.

override long Seek (long offset, SeekOrigin origin)

This method has no effect on the Stream.

Properties

override bool CanRead [get]

Gets a value indicating whether the current stream supports reading.

override bool CanWrite [get]

Gets a value indicating whether the current stream supports writing.

override bool CanSeek [get]

Gets a value indicating whether the current stream supports seeking. This stream cannot seek, and will always return false.

override long Length [get]

Gets the length in bytes of the stream.

override long Position [get, set]

Gets or sets the position within the current stream. This Stream cannot seek. This property has no effect on the Stream and will always return 0.

Detailed Description

Summary description for CombinedStream.

Definition at line 39 of file CombinedStream.cs.

Constructor & Destructor Documentation

Tamir.Streams.CombinedStream.CombinedStream	(	Stream	inputStream,
		Stream	outputStream
	)

Definition at line 44 of file CombinedStream.cs.

Member Function Documentation

override void Tamir.Streams.CombinedStream.Close ( )

Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.

Definition at line 114 of file CombinedStream.cs.

override void Tamir.Streams.CombinedStream.Flush ( )

Clears all buffers for this stream and causes any buffered data to be written to the underlying device.

Definition at line 161 of file CombinedStream.cs.

virtual int Tamir.Streams.CombinedStream.Read ( byte[] buffer ) [virtual]

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Parameters:

buffer

An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count- 1) replaced by the bytes read from the current source.

Returns:: The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

Definition at line 67 of file CombinedStream.cs.

override int Tamir.Streams.CombinedStream.Read	(	byte[]	buffer,
		int	offset,
		int	count
	)

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Parameters:

	buffer	An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count- 1) replaced by the bytes read from the current source.
	offset	The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
	count	The maximum number of bytes to be read from the current stream.

Returns:: The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

Definition at line 57 of file CombinedStream.cs.

override int Tamir.Streams.CombinedStream.ReadByte ( )

Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.

Returns:: The unsigned byte cast to an Int32, or -1 if at the end of the stream.

Definition at line 76 of file CombinedStream.cs.

override long Tamir.Streams.CombinedStream.Seek	(	long	offset,
		SeekOrigin	origin
	)

This method has no effect on the Stream.

Definition at line 201 of file CombinedStream.cs.

override void Tamir.Streams.CombinedStream.SetLength ( long value )

This method has no effect on the Stream.

Definition at line 194 of file CombinedStream.cs.

virtual void Tamir.Streams.CombinedStream.Write ( byte[] buffer ) [virtual]

Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Parameters:

buffer

An array of bytes. This method copies count bytes from buffer to the current stream.

Definition at line 105 of file CombinedStream.cs.

override void Tamir.Streams.CombinedStream.Write	(	byte[]	buffer,
		int	offset,
		int	count
	)

Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Parameters:

	buffer	An array of bytes. This method copies count bytes from buffer to the current stream.
	offset	The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
	count	The number of bytes to be written to the current stream.

Definition at line 96 of file CombinedStream.cs.

override void Tamir.Streams.CombinedStream.WriteByte ( byte value )

Writes a byte to the current position in the stream and advances the position within the stream by one byte.

Parameters:

value

The byte to write to the stream.

Definition at line 85 of file CombinedStream.cs.

Property Documentation

override bool Tamir.Streams.CombinedStream.CanRead [get]

Gets a value indicating whether the current stream supports reading.

Definition at line 129 of file CombinedStream.cs.

override bool Tamir.Streams.CombinedStream.CanSeek [get]

Gets a value indicating whether the current stream supports seeking. This stream cannot seek, and will always return false.

Definition at line 151 of file CombinedStream.cs.

override bool Tamir.Streams.CombinedStream.CanWrite [get]

Gets a value indicating whether the current stream supports writing.

Definition at line 140 of file CombinedStream.cs.

override long Tamir.Streams.CombinedStream.Length [get]

Gets the length in bytes of the stream.

Definition at line 170 of file CombinedStream.cs.

override long Tamir.Streams.CombinedStream.Position [get, set]

Gets or sets the position within the current stream. This Stream cannot seek. This property has no effect on the Stream and will always return 0.

Definition at line 181 of file CombinedStream.cs.

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

C:/work/OMMR/OCHHP_OMMR_OMMR/Code/Assemblies/SharpSSH/Source/SharpSSH-1.1.1.13.src/SharpSSH/Streams/CombinedStream.cs


Public Member Functions
	CombinedStream (Stream inputStream, Stream outputStream)
override int	Read (byte[] buffer, int offset, int count)
	Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
virtual int	Read (byte[] buffer)
	Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
override int	ReadByte ()
	Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
override void	WriteByte (byte value)
	Writes a byte to the current position in the stream and advances the position within the stream by one byte.
override void	Write (byte[] buffer, int offset, int count)
	Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
virtual void	Write (byte[] buffer)
	Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
override void	Close ()
	Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
override void	Flush ()
	Clears all buffers for this stream and causes any buffered data to be written to the underlying device.
override void	SetLength (long value)
	This method has no effect on the Stream.
override long	Seek (long offset, SeekOrigin origin)
	This method has no effect on the Stream.
Properties
override bool	CanRead `[get]`
	Gets a value indicating whether the current stream supports reading.
override bool	CanWrite `[get]`
	Gets a value indicating whether the current stream supports writing.
override bool	CanSeek `[get]`
	Gets a value indicating whether the current stream supports seeking. This stream cannot seek, and will always return false.
override long	Length `[get]`
	Gets the length in bytes of the stream.
override long	Position `[get, set]`
	Gets or sets the position within the current stream. This Stream cannot seek. This property has no effect on the Stream and will always return 0.