org.eclipse.jetty.server

Class HttpInput<T>

java.lang.Object

java.io.InputStream

javax.servlet.ServletInputStream

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

Type Parameters:

T -

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

HttpInputOverHTTP, QueuedHttpInput

public abstract class HttpInput<T>
extends ServletInputStream
implements Runnable

Author:

gregw

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	HttpInput.State

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpInput.State	_state
protected static HttpInput.State	ASYNC
protected static HttpInput.State	BLOCKING
protected static HttpInput.State	EARLY_EOF
protected static HttpInput.State	EOF

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpInput()
protected	HttpInput(Object lock)

Method Summary

Methods

Modifier and Type	Method and Description
int	available()
protected abstract void	blockForContent()
protected abstract void	consume(T item, int length)
void	consumeAll()
abstract 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	failed(Throwable x)
protected abstract int	get(T item, byte[] buffer, int offset, int length)
long	getContentRead()
protected T	getNextContent() A convenience method to call nextContent and to check the return value, which if null then the a check is made for EOF and the state changed accordingly.
void	init(HttpChannelState state)
boolean	isFinished()
boolean	isReady()
Object	lock()
void	messageComplete()
protected abstract T	nextContent() Access the next content to be consumed from.
protected boolean	onAsyncRead()
int	read()
int	read(byte[] b, int off, int len)
void	recycle()
protected abstract int	remaining(T item)
void	run()
void	setReadListener(ReadListener readListener)
protected void	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

Field Detail

_state

protected HttpInput.State _state

BLOCKING

protected static final HttpInput.State BLOCKING

ASYNC

protected static final HttpInput.State ASYNC

EARLY_EOF

protected static final HttpInput.State EARLY_EOF

EOF

protected static final HttpInput.State EOF

Constructor Detail

HttpInput

protected HttpInput()

HttpInput

protected HttpInput(Object lock)

Method Detail

lock

public final Object lock()

recycle

public void recycle()

nextContent

protected abstract T nextContent()
                          throws IOException

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 get(Object, byte[], int, int) or consume(Object, int) are required to consume data from the content.

Returns:

Content or null if none available.

Throws:

IOException

getNextContent

protected T getNextContent()
                    throws IOException

A convenience method to call nextContent and to check the return value, which if null then the a check is made for EOF and the state changed accordingly.

Returns:

Content or null if none available.

Throws:

IOException

See Also:

nextContent()

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

available

public int available()

Overrides:

available in class InputStream

read

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

Overrides:

read in class InputStream

Throws:

IOException

remaining

protected abstract int remaining(T item)

get

protected abstract int get(T item,
      byte[] buffer,
      int offset,
      int length)

consume

protected abstract void consume(T item,
           int length)

blockForContent

protected abstract void blockForContent()
                                 throws IOException

Throws:

IOException

onAsyncRead

protected boolean onAsyncRead()

getContentRead

public long getContentRead()

content

public abstract void content(T item)

Add some content to the input stream

Parameters:

item -

earlyEOF

public void earlyEOF()

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.

messageComplete

public void messageComplete()

consumeAll

public void consumeAll()

isFinished

public boolean isFinished()

Specified by:

isFinished in class ServletInputStream

isReady

public boolean isReady()

Specified by:

isReady in class ServletInputStream

unready

protected void unready()

setReadListener

public void setReadListener(ReadListener readListener)

Specified by:

setReadListener in class ServletInputStream

failed

public void failed(Throwable x)

run

public void run()

Specified by:

run in interface Runnable

init

public void init(HttpChannelState state)