org.eclipse.jetty.server

Class HttpInput<T>

java.lang.Object

java.io.InputStream

javax.servlet.ServletInputStream

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

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ByteBufferHttpInput

public abstract class HttpInput<T>
extends javax.servlet.ServletInputStream

HttpInput provides an implementation of ServletInputStream for HttpChannel.

HttpInput holds a queue of items passed to it by calls to #content(T).

HttpInput 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 #onContentQueued(T), #onContentConsumed(T) and onAllContentConsumed() that can be implemented so that the caller will know when buffers are queued and consumed.

Constructor Summary

Constructors

Constructor and Description
HttpInput()

Method Summary

Methods

Modifier and Type	Method and Description
int	available()
protected void	blockForContent()
void	consumeAll()
boolean	content(T item)
void	earlyEOF()
protected abstract int	get(T item, byte[] buffer, int offset, int length)
boolean	isEarlyEOF()
boolean	isShutdown()
Object	lock()
protected void	onAllContentConsumed()
protected abstract void	onContentConsumed(T item)
protected void	onContentQueued(T item)
protected void	onEOF()
int	read()
int	read(byte[] b, int off, int len)
void	recycle()
protected abstract int	remaining(T item)
void	shutdown()

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

HttpInput

public HttpInput()

Method Detail

lock

public Object lock()

recycle

public void recycle()

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)

onContentConsumed

protected abstract void onContentConsumed(T item)

blockForContent

protected void blockForContent()
                        throws IOException

Throws:

IOException

onContentQueued

protected void onContentQueued(T item)

onAllContentConsumed

protected void onAllContentConsumed()

onEOF

protected void onEOF()

content

public boolean content(T item)

earlyEOF

public void earlyEOF()

isEarlyEOF

public boolean isEarlyEOF()

shutdown

public void shutdown()

isShutdown

public boolean isShutdown()

consumeAll

public void consumeAll()