org.eclipse.jetty.server

Class QueuedHttpInput<T>

java.lang.Object

java.io.InputStream

javax.servlet.ServletInputStream

org.eclipse.jetty.server.HttpInput<T>

org.eclipse.jetty.server.QueuedHttpInput<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

ByteBufferQueuedHttpInput

public abstract class QueuedHttpInput<T>
extends HttpInput<T>

QueuedHttpInput provides an implementation of ServletInputStream for HttpChannel.

QueuedHttpInput holds a queue of items passed to it by calls to content(Object).

QueuedHttpInput stores the items directly; if the items contain byte buffers, it does not copy them but simply holds references to the item, thus the caller must organize for those buffers to valid while held by this class.

To assist the caller, subclasses may override methods HttpInput.onAsyncRead(), onContentConsumed(Object) and onAllContentConsumed() that can be implemented so that the caller will know when buffers are queued and consumed.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.server.HttpInput

HttpInput.State

Field Summary

Fields inherited from class org.eclipse.jetty.server.HttpInput

_state, ASYNC, BLOCKING, EARLY_EOF, EOF

Constructor Summary

Constructors

Constructor and Description
QueuedHttpInput()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	blockForContent()
void	content(T item) Add some content to the input stream
void	earlyEOF() This method should be called to signal to the HttpInput that an EOF has arrived before all the expected content.
void	messageComplete()
protected T	nextContent() Access the next content to be consumed from.
protected void	onAllContentConsumed() Called by this HttpInput to signal all available content has been consumed
protected abstract void	onContentConsumed(T item)
void	recycle()

Methods inherited from class org.eclipse.jetty.server.HttpInput

available, consume, consumeAll, failed, get, getContentRead, getNextContent, init, isFinished, isReady, lock, onAsyncRead, read, read, remaining, run, setReadListener, unready

Methods inherited from class javax.servlet.ServletInputStream

readLine

Methods inherited from class java.io.InputStream

close, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

QueuedHttpInput

public QueuedHttpInput()

Method Detail

recycle

public void recycle()

Overrides:

recycle in class HttpInput<T>

nextContent

protected T nextContent()

Description copied from class: HttpInput

Access the next content to be consumed from. Returning the next item does not consume it and it may be returned multiple times until it is consumed. Calls to HttpInput.get(Object, byte[], int, int) or HttpInput.consume(Object, int) are required to consume data from the content.

Specified by:

nextContent in class HttpInput<T>

Returns:

Content or null if none available.

onContentConsumed

protected abstract void onContentConsumed(T item)

blockForContent

protected void blockForContent()
                        throws IOException

Specified by:

blockForContent in class HttpInput<T>

Throws:

IOException

onAllContentConsumed

protected void onAllContentConsumed()

Called by this HttpInput to signal all available content has been consumed

content

public void content(T item)

Add some content to the input stream

Specified by:

content in class HttpInput<T>

Parameters:

item -

earlyEOF

public void earlyEOF()

Description copied from class: HttpInput

This method should be called to signal to the HttpInput that an EOF has arrived before all the expected content. Typically this will result in an EOFException being thrown from a subsequent read rather than a -1 return.

Overrides:

earlyEOF in class HttpInput<T>

messageComplete

public void messageComplete()

Overrides:

messageComplete in class HttpInput<T>