Modifier and Type	Class and Description
private class	OutputStreamContentSource.AsyncOutputStream

Modifier and Type	Field and Description
private final AsyncContent	async
private final OutputStreamContentSource.AsyncOutputStream	output

Access	Constructor and Description
public	OutputStreamContentSource()

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public void	demand(Runnable the demand callback to invoke where there is a content chunk available demandCallback) Implements org.eclipse.jetty.io.Content.Source.demand. Demands to invoke the given demand callback parameter when a chunk of content is available.
public void	fail(Throwable the cause of the failure failure) Implements org.eclipse.jetty.io.Content.Source.fail. Fails this content source with a `last` `failure chunk`, failing and discarding accumulated content chunks that were not yet read.
public long	getLength() Overrides default org.eclipse.jetty.io.Content.Source.getLength.
public OutputStream	getOutputStream()
public Content.Chunk	read() Implements org.eclipse.jetty.io.Content.Source.read. Reads a chunk of content.

async	back to summary
private final AsyncContent async

output	back to summary
private final OutputStreamContentSource.AsyncOutputStream output

OutputStreamContentSource	back to summary
public OutputStreamContentSource()

Method Detail

close back to summary

close	back to summary
public void close() Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override

public void close()

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

demand back to summary

demand	back to summary
public void demand(Runnable demandCallback) Implements org.eclipse.jetty.io.Content.Source.demand. Doc from org.eclipse.jetty.io.Content.Source.demand. Demands to invoke the given demand callback parameter when a chunk of content is available. See how to use this method idiomatically. Implementations guarantee that calls to this method are safely reentrant so that stack overflows are avoided in the case of mutual recursion between the execution of the `Runnable` callback and a call to this method. Invocations of the passed `Runnable` are serialized and a callback for `demand` call is not invoked until any previous `demand` callback has returned. Thus the `Runnable` should not block waiting for a callback of a future demand call. The demand callback may be invoked spuriously: a subsequent call to `read()` may return `null`. Calling this method establishes a pending demand, which is fulfilled when the demand callback is invoked. Calling this method when there is already a pending demand results in an `IllegalStateException` to be thrown. If the invocation of the demand callback throws an exception, then `fail(Throwable)` is called. Parameters demandCallback:Runnable the demand callback to invoke where there is a content chunk available Annotations @Override

public void demand(Runnable demandCallback)

Implements org.eclipse.jetty.io.Content.Source.demand.

Doc from org.eclipse.jetty.io.Content.Source.demand.

Demands to invoke the given demand callback parameter when a chunk of content is available.

See how to use this method idiomatically.

Implementations guarantee that calls to this method are safely reentrant so that stack overflows are avoided in the case of mutual recursion between the execution of the Runnable callback and a call to this method. Invocations of the passed Runnable are serialized and a callback for demand call is not invoked until any previous demand callback has returned. Thus the Runnable should not block waiting for a callback of a future demand call.

The demand callback may be invoked spuriously: a subsequent call to read() may return null.

Calling this method establishes a pending demand, which is fulfilled when the demand callback is invoked.

Calling this method when there is already a pending demand results in an IllegalStateException to be thrown.

If the invocation of the demand callback throws an exception, then fail(Throwable) is called.

Parameters

demandCallback:Runnable: the demand callback to invoke where there is a content chunk available

Annotations

@Override

fail back to summary

fail	back to summary
public void fail(Throwable failure) Implements org.eclipse.jetty.io.Content.Source.fail. Doc from org.eclipse.jetty.io.Content.Source.fail. Fails this content source with a `last` `failure chunk`, failing and discarding accumulated content chunks that were not yet read. The failure may be notified to the content reader at a later time, when the content reader reads a content chunk, via a `Chunk` instance with a non null `Chunk#getFailure()`. If `read()` has returned a last chunk, this is a no operation. Typical failure: the content being aborted by user code, or idle timeouts. If this method has already been called, then it is a no operation. Parameters failure:Throwable the cause of the failure Annotations @Override

public void fail(Throwable failure)

Implements org.eclipse.jetty.io.Content.Source.fail.

Doc from org.eclipse.jetty.io.Content.Source.fail.

Fails this content source with a last failure chunk, failing and discarding accumulated content chunks that were not yet read.

The failure may be notified to the content reader at a later time, when the content reader reads a content chunk, via a Chunk instance with a non null Chunk#getFailure().

If read() has returned a last chunk, this is a no operation.

Typical failure: the content being aborted by user code, or idle timeouts.

If this method has already been called, then it is a no operation.

Parameters

failure:Throwable: the cause of the failure

Annotations

@Override

getLength	back to summary
public long getLength() Overrides default org.eclipse.jetty.io.Content.Source.getLength. Returns:long Doc from org.eclipse.jetty.io.Content.Source.getLength. the content length, if known, or -1 if the content length is unknown Annotations @Override

getLength

back to summary

public long getLength()

Overrides default org.eclipse.jetty.io.Content.Source.getLength.

Returns:long

Doc from org.eclipse.jetty.io.Content.Source.getLength.

the content length, if known, or -1 if the content length is unknown

Annotations

@Override

getOutputStream	back to summary
public OutputStream getOutputStream()

read back to summary

read	back to summary
public Content.Chunk read() Implements org.eclipse.jetty.io.Content.Source.read. Doc from org.eclipse.jetty.io.Content.Source.read. Reads a chunk of content. See how to use this method idiomatically. The returned chunk could be: `null`, to signal that there isn't a chunk of content available an `Chunk` instance with non null `Chunk#getFailure()`, to signal that there was a failure trying to produce a chunk of content, or that the content production has been `failed` externally a `Chunk` instance, containing the chunk of content. Once a read returns an `Chunk` instance with non-null `Chunk#getFailure()` then if the failure is `last` further reads will continue to return the same failure chunk instance, otherwise further `read()` operations may return different non-failure chunks. Once a read returns a `last chunk`, further reads will continue to return a last chunk (although the instance may be different). The content reader code must ultimately arrange for a call to `Chunk#release()` on the returned `Chunk`. Additionally, prior to the ultimate call to `Chunk#release()`, the reader code may make additional calls to `Chunk#retain()`, that must ultimately be matched by a correspondent number of calls to `Chunk#release()`. Concurrent reads from different threads are not recommended, as they are inherently in a race condition. Reads performed outside the invocation context of a `demand callback` are allowed. However, reads performed with a pending demand are inherently in a race condition (the thread that reads with the thread that invokes the demand callback). Returns:Content.Chunk a chunk of content, possibly a failure instance, or `null` Annotations @Override

public Content.Chunk read()

Implements org.eclipse.jetty.io.Content.Source.read.

Doc from org.eclipse.jetty.io.Content.Source.read.

Reads a chunk of content.

See how to use this method idiomatically.

The returned chunk could be:

null, to signal that there isn't a chunk of content available
an Chunk instance with non null Chunk#getFailure(), to signal that there was a failure trying to produce a chunk of content, or that the content production has been failed externally
a Chunk instance, containing the chunk of content.

Once a read returns an Chunk instance with non-null Chunk#getFailure() then if the failure is last further reads will continue to return the same failure chunk instance, otherwise further read() operations may return different non-failure chunks.

Once a read returns a last chunk, further reads will continue to return a last chunk (although the instance may be different).

The content reader code must ultimately arrange for a call to Chunk#release() on the returned Chunk.

Additionally, prior to the ultimate call to Chunk#release(), the reader code may make additional calls to Chunk#retain(), that must ultimately be matched by a correspondent number of calls to Chunk#release().

Concurrent reads from different threads are not recommended, as they are inherently in a race condition.

Reads performed outside the invocation context of a demand callback are allowed. However, reads performed with a pending demand are inherently in a race condition (the thread that reads with the thread that invokes the demand callback).

Returns:Content.Chunk

a chunk of content, possibly a failure instance, or null

Annotations

@Override

org.eclipse.jetty.io.content back to summary

private Class OutputStreamContentSource.AsyncOutputStream

Class Inheritance

extends OutputStream

java.lang.Object
java.io.OutputStream
org.eclipse.jetty.io.content.OutputStreamContentSource.AsyncOutputStream

Constructor Summary

Access	Constructor and Description
private	AsyncOutputStream()

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	flush() Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flushes this output stream and forces any buffered output bytes to be written out.
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.

Inherited from java.io.OutputStream:: nullOutputStream write

Constructor Detail

AsyncOutputStream	back to summary
private AsyncOutputStream()

Method Detail

close back to summary

close	back to summary
public void close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Doc from java.io.OutputStream.close. Closes this output stream and releases any system resources associated with this stream. The general contract of `close` is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. Annotations @Override

public void close()

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Annotations

@Override

flush back to summary

flush	back to summary
public void flush() throws IOException Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Doc from java.io.OutputStream.flush. Flushes this output stream and forces any buffered output bytes to be written out. The general contract of `flush` is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination. If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(int b) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the `byte`. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write back to summary

write	back to summary
public void write(byte[] b, int off, int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. Parameters b:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

public void write(byte[] b, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

public Class OutputStreamContentSource

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class OutputStreamContentSource.AsyncOutputStream

Constructor Summary

Method Summary

Constructor Detail

Method Detail