PipedInputStream Class

Definition

Namespace:

Java.IO

Assembly:

Mono.Android.dll

A piped input stream should be connected to a piped output stream; the piped input stream then provides whatever data bytes are written to the piped output stream.

[Android.Runtime.Register("java/io/PipedInputStream", DoNotGenerateAcw=true)]
public class PipedInputStream : Java.IO.InputStream

[<Android.Runtime.Register("java/io/PipedInputStream", DoNotGenerateAcw=true)>]
type PipedInputStream = class
    inherit InputStream

Inheritance

Object

Object

InputStream

PipedInputStream

Attributes

RegisterAttribute

Remarks

A piped input stream should be connected to a piped output stream; the piped input stream then provides whatever data bytes are written to the piped output stream. Typically, data is read from a PipedInputStream object by one thread and data is written to the corresponding PipedOutputStream by some other thread. Attempting to use both objects from a single thread is not recommended, as it may deadlock the thread. The piped input stream contains a buffer, decoupling read operations from write operations, within limits. A pipe is said to be "BROKEN"> <i>broken</i> if a thread that was providing data bytes to the connected piped output stream is no longer alive.

Added in 1.0.

Java documentation for java.io.PipedInputStream.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

PipedInputStream()	Creates a PipedInputStream so that it is not yet #connect(java.
PipedInputStream(Int32)	Creates a PipedInputStream so that it is not yet #connect(java.
PipedInputStream(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.
PipedInputStream(PipedOutputStream)	Creates a PipedInputStream so that it is connected to the piped output stream src.
PipedInputStream(PipedOutputStream, Int32)	Creates a PipedInputStream so that it is connected to the piped output stream src and uses the specified pipe size for the pipe's buffer.

Fields

PipeSize

The default size of the pipe's circular input buffer.

Properties

Buffer	The circular buffer into which incoming data is placed.
Class	Returns the runtime class of this Object. (Inherited from Object)
Handle	The handle to the underlying Android instance. (Inherited from Object)
In	The index of the position in the circular buffer at which the next byte of data will be stored when received from the connected piped output stream.
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
Out	The index of the position in the circular buffer at which the next byte of data will be read by this piped input stream.
PeerReference	(Inherited from Object)
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Available()	Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. (Inherited from InputStream)
Clone()	Creates and returns a copy of this object. (Inherited from Object)
Close()	Closes this input stream and releases any system resources associated with the stream. (Inherited from InputStream)
Connect(PipedOutputStream)	Causes this piped input stream to be connected to the piped output stream src.
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Mark(Int32)	Marks the current position in this input stream. (Inherited from InputStream)
MarkSupported()	Tests if this input stream supports the mark and reset methods. (Inherited from InputStream)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
Read()	Reads the next byte of data from this piped input stream.
Read(Byte[])	Reads some number of bytes from the input stream and stores them into the buffer array b. (Inherited from InputStream)
Read(Byte[], Int32, Int32)	Reads up to len bytes of data from the input stream into an array of bytes. (Inherited from InputStream)
ReadAllBytes()	Reads all remaining bytes from the input stream. (Inherited from InputStream)
ReadAsync()	(Inherited from InputStream)
ReadAsync(Byte[])	(Inherited from InputStream)
ReadAsync(Byte[], Int32, Int32)	(Inherited from InputStream)
ReadNBytes(Byte[], Int32, Int32)	Reads the requested number of bytes from the input stream into the given byte array. (Inherited from InputStream)
ReadNBytes(Int32)	Reads up to a specified number of bytes from the input stream. (Inherited from InputStream)
Receive(Int32)	Receives a byte of data.
ReceiveAsync(Int32)
Reset()	Repositions this stream to the position at the time the mark method was last called on this input stream. (Inherited from InputStream)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
Skip(Int64)	Skips over and discards n bytes of data from this input stream. (Inherited from InputStream)
SkipAsync(Int64)	(Inherited from InputStream)
SkipNBytes(Int64)	Skips over and discards exactly n bytes of data from this input stream. (Inherited from InputStream)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
TransferTo(Stream)	Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read. (Inherited from InputStream)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)