Tamir.Streams.PipedOutputStream Class Reference

Inheritance diagram for Tamir.Streams.PipedOutputStream:

List of all members.

Public Member Functions
	PipedOutputStream (PipedInputStream snk)
	PipedOutputStream ()
virtual void	connect (PipedInputStream snk)
virtual void	write (int b)
override void	write (byte[] b, int off, int len)
virtual void	write (byte[] b)
override void	flush ()
override void	close ()
override int	Read (byte[] buffer, int offset, int count)
override int	ReadByte ()
override void	WriteByte (byte value)
override void	Write (byte[] buffer, int offset, int count)
virtual void	Write (byte[] buffer)
override void	Close ()
override void	Flush ()
override void	SetLength (long value)
override long	Seek (long offset, SeekOrigin origin)
Properties
override bool	CanRead [get]
override bool	CanWrite [get]
override bool	CanSeek [get]
override long	Length [get]
override long	Position [get, set]

---

Detailed Description

A piped output stream can be connected to a piped input stream to create a communications pipe. The piped output stream is the sending end of the pipe. Typically, data is written to a

PipedOutputStream

object by one thread and data is read from the connected

PipedInputStream

by some other thread. Attempting to use both objects from a single thread is not recommended as it may deadlock the thread.

Author:

James Gosling

Version:

1.26, 12/19/03

See also:

java.io.PipedInputStream

Since:

JDK1.0

Definition at line 28 of file PipedOutputStream.cs.

---

Constructor & Destructor Documentation

Tamir.Streams.PipedOutputStream.PipedOutputStream

(

PipedInputStream

snk

)

Creates a piped output stream connected to the specified piped input stream. Data bytes written to this stream will then be available as input from

snk

.

Parameters:

snk

The piped input stream to connect to.

Exceptions:

IOException

if an I/O error occurs.

Definition at line 45 of file PipedOutputStream.cs.

Tamir.Streams.PipedOutputStream.PipedOutputStream

(

)

Creates a piped output stream that is not yet connected to a piped input stream. It must be connected to a piped input stream, either by the receiver or the sender, before being used.

See also:

java.io.PipedInputStream.connect(java.io.PipedOutputStream)

java.io.PipedOutputStream.connect(java.io.PipedInputStream)

Definition at line 58 of file PipedOutputStream.cs.

---

Member Function Documentation

override void Tamir.Streams.PipedOutputStream.Close

(

)

Definition at line 218 of file PipedOutputStream.cs.

override void Tamir.Streams.PipedOutputStream.close

(

)

[virtual]

Closes this piped output stream and releases any system resources associated with this stream. This stream may no longer be used for writing bytes.

Exceptions:

IOException

if an I/O error occurs.

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 184 of file PipedOutputStream.cs.

virtual void Tamir.Streams.PipedOutputStream.connect

(

PipedInputStream

snk

)

[virtual]

Connects this piped output stream to a receiver. If this object is already connected to some other piped input stream, an

IOException

is thrown.

If

snk

is an unconnected piped input stream and

src

is an unconnected piped output stream, they may be connected by either the call: <blockquote>

 src.connect(snk)

</blockquote> or the call: <blockquote>

 snk.connect(src)

</blockquote> The two calls have the same effect.

Parameters:

snk

the piped input stream to connect to.

Exceptions:

IOException

if an I/O error occurs.

Definition at line 81 of file PipedOutputStream.cs.

override void Tamir.Streams.PipedOutputStream.Flush

(

)

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 244 of file PipedOutputStream.cs.

override void Tamir.Streams.PipedOutputStream.flush

(

)

[virtual]

Flushes this output stream and forces any buffered output bytes to be written out. This will notify any readers that bytes are waiting in the pipe.

Exceptions:

IOException

if an I/O error occurs.

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 165 of file PipedOutputStream.cs.

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

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 195 of file PipedOutputStream.cs.

override int Tamir.Streams.PipedOutputStream.ReadByte

(

)

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 200 of file PipedOutputStream.cs.

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

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 270 of file PipedOutputStream.cs.

override void Tamir.Streams.PipedOutputStream.SetLength

(

long

value

)

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 266 of file PipedOutputStream.cs.

virtual void Tamir.Streams.PipedOutputStream.Write

(

byte[]

buffer

)

[virtual]

Definition at line 214 of file PipedOutputStream.cs.

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

Definition at line 210 of file PipedOutputStream.cs.

virtual void Tamir.Streams.PipedOutputStream.write

(

byte[]

b

)

[virtual]

Definition at line 152 of file PipedOutputStream.cs.

override void Tamir.Streams.PipedOutputStream.write	(	byte[]	b,
		int	off,
		int	len
	)			[virtual]

Writes

len

bytes from the specified byte array starting at offset

off

to this piped output stream. If a thread was reading data bytes from the connected piped input stream, but the thread is no longer alive, then an

IOException

is thrown.

Parameters:

	b	the data.
	off	the start offset in the data.
	len	the number of bytes to write.

Exceptions:

IOException

if an I/O error occurs.

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 130 of file PipedOutputStream.cs.

virtual void Tamir.Streams.PipedOutputStream.write

(

int

b

)

[virtual]

Writes the specified

byte

to the piped output stream. If a thread was reading data bytes from the connected piped input stream, but the thread is no longer alive, then an

IOException

is thrown.

Implements the

write

method of

OutputStream

.

Parameters:

b

the byte to be written.

Exceptions:

IOException

if an I/O error occurs.

Definition at line 109 of file PipedOutputStream.cs.

override void Tamir.Streams.PipedOutputStream.WriteByte

(

byte

value

)

Definition at line 205 of file PipedOutputStream.cs.

---

Property Documentation

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

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 224 of file PipedOutputStream.cs.

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

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 238 of file PipedOutputStream.cs.

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

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 231 of file PipedOutputStream.cs.

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

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 249 of file PipedOutputStream.cs.

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

Reimplemented from Tamir.SharpSsh.java.io.OutputStream.

Definition at line 256 of file PipedOutputStream.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/PipedOutputStream.cs