io.grpc

Class DeferredInputStream<T>

java.lang.Object

java.io.InputStream

io.grpc.DeferredInputStream<T>

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

DeferredNanoProtoInputStream, DeferredProtoInputStream

public abstract class DeferredInputStream<T>
extends InputStream

Extension to InputStream to allow for deferred production of data. Allows for zero-copy conversions when the goal is to copy the contents of a resource to a stream or buffer.

Constructor Summary

Constructors

Constructor and Description
DeferredInputStream()

Method Summary

Modifier and Type	Method and Description
abstract int	flushTo(OutputStream target) Produce the entire contents of this stream to the specified target.
abstract T	getDeferred() Returns the object that backs the stream.

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeferredInputStream

public DeferredInputStream()

Method Detail

flushTo

public abstract int flushTo(OutputStream target)
                     throws IOException

Produce the entire contents of this stream to the specified target.

Parameters:

target - to write to.

Returns:

number of bytes written.

Throws:

IOException

getDeferred

@Nullable
public abstract T getDeferred()

Returns the object that backs the stream. If any bytes have been read from the stream then null is returned.