org.eclipse.jetty.io

Class ByteArrayEndPoint

java.lang.Object

org.eclipse.jetty.io.IdleTimeout

org.eclipse.jetty.io.AbstractEndPoint

org.eclipse.jetty.io.ByteArrayEndPoint

All Implemented Interfaces:

Closeable, AutoCloseable, EndPoint

Direct Known Subclasses:

LocalConnector.LocalEndPoint

public class ByteArrayEndPoint
extends AbstractEndPoint

ByteArrayEndPoint.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_closed
protected boolean	_growOutput
protected ByteBuffer	_in
protected boolean	_ishut
protected boolean	_oshut
protected ByteBuffer	_out
static InetSocketAddress	NOIP

Constructor Summary

Constructors

Constructor and Description
ByteArrayEndPoint()
ByteArrayEndPoint(byte[] input, int outputSize)
ByteArrayEndPoint(Scheduler scheduler, long idleTimeoutMs)
ByteArrayEndPoint(Scheduler timer, long idleTimeoutMs, byte[] input, int outputSize)
ByteArrayEndPoint(Scheduler timer, long idleTimeoutMs, ByteBuffer input, ByteBuffer output)
ByteArrayEndPoint(Scheduler timer, long idleTimeoutMs, String input, int outputSize)
ByteArrayEndPoint(String input, int outputSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close any backing stream associated with the endpoint
int	fill(ByteBuffer buffer) Fill the passed buffer with data from this endpoint.
boolean	flush(ByteBuffer... buffers) Flush data from the passed header/buffer to this endpoint.
ByteBuffer	getIn()
ByteBuffer	getOutput()
String	getOutputString()
String	getOutputString(Charset charset)
Object	getTransport()
boolean	hasMore()
boolean	isGrowOutput()
boolean	isInputShutdown() Test if the input is shutdown.
boolean	isOpen() This abstract method should be called to check if idle timeouts should still be checked.
boolean	isOutputShutdown() Test if output is shutdown.
protected boolean	needsFill()
protected void	onIncompleteFlush()
void	reset()
void	setGrowOutput(boolean growOutput)
void	setInput(ByteBuffer in)
void	setInput(String s)
void	setInput(String s, Charset charset)
void	setInputEOF()
void	setOutput(ByteBuffer out)
void	shutdownOutput() Shutdown the output.
ByteBuffer	takeOutput()
String	takeOutputString()
String	takeOutputString(Charset charset)

Methods inherited from class org.eclipse.jetty.io.AbstractEndPoint

fillInterested, getConnection, getCreatedTimeStamp, getFillInterest, getLocalAddress, getRemoteAddress, getWriteFlusher, onClose, onIdleExpired, onOpen, setConnection, toString, write

Methods inherited from class org.eclipse.jetty.io.IdleTimeout

checkIdleTimeout, getIdleTimeout, getIdleTimestamp, notIdle, setIdleTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.io.EndPoint

getIdleTimeout, setIdleTimeout

Field Detail

NOIP

public static final InetSocketAddress NOIP

_in

protected volatile ByteBuffer _in

_out

protected volatile ByteBuffer _out

_ishut

protected volatile boolean _ishut

_oshut

protected volatile boolean _oshut

_closed

protected volatile boolean _closed

_growOutput

protected volatile boolean _growOutput

Constructor Detail

ByteArrayEndPoint

public ByteArrayEndPoint()

ByteArrayEndPoint

public ByteArrayEndPoint(byte[] input,
                 int outputSize)

ByteArrayEndPoint

public ByteArrayEndPoint(String input,
                 int outputSize)

ByteArrayEndPoint

public ByteArrayEndPoint(Scheduler scheduler,
                 long idleTimeoutMs)

ByteArrayEndPoint

public ByteArrayEndPoint(Scheduler timer,
                 long idleTimeoutMs,
                 byte[] input,
                 int outputSize)

ByteArrayEndPoint

public ByteArrayEndPoint(Scheduler timer,
                 long idleTimeoutMs,
                 String input,
                 int outputSize)

ByteArrayEndPoint

public ByteArrayEndPoint(Scheduler timer,
                 long idleTimeoutMs,
                 ByteBuffer input,
                 ByteBuffer output)

Method Detail

onIncompleteFlush

protected void onIncompleteFlush()

Specified by:

onIncompleteFlush in class AbstractEndPoint

needsFill

protected boolean needsFill()
                     throws IOException

Specified by:

needsFill in class AbstractEndPoint

Throws:

IOException

getIn

public ByteBuffer getIn()

Returns:

Returns the in.

setInputEOF

public void setInputEOF()

setInput

public void setInput(ByteBuffer in)

Parameters:

in - The in to set.

setInput

public void setInput(String s)

setInput

public void setInput(String s,
            Charset charset)

getOutput

public ByteBuffer getOutput()

Returns:

Returns the out.

getOutputString

public String getOutputString()

Returns:

Returns the out.

getOutputString

public String getOutputString(Charset charset)

Returns:

Returns the out.

takeOutput

public ByteBuffer takeOutput()

Returns:

Returns the out.

takeOutputString

public String takeOutputString()

Returns:

Returns the out.

takeOutputString

public String takeOutputString(Charset charset)

Returns:

Returns the out.

setOutput

public void setOutput(ByteBuffer out)

Parameters:

out - The out to set.

isOpen

public boolean isOpen()

Description copied from class: IdleTimeout

This abstract method should be called to check if idle timeouts should still be checked.

Specified by:

isOpen in interface EndPoint

Specified by:

isOpen in class IdleTimeout

Returns:

True if the entity monitored should still be checked for idle timeouts

isInputShutdown

public boolean isInputShutdown()

Description copied from interface: EndPoint

Test if the input is shutdown. The input is shutdown if an EOF has been read while doing a EndPoint.fill(ByteBuffer). Once the input is shutdown, all calls to EndPoint.fill(ByteBuffer) will return -1, until such time as the end point is close, when they will return EofException.

Returns:

True if the input is shutdown or the endpoint is closed.

isOutputShutdown

public boolean isOutputShutdown()

Description copied from interface: EndPoint

Test if output is shutdown. The output is shutdown by a call to EndPoint.shutdownOutput() or EndPoint.close().

Returns:

true if the output is shutdown or the endpoint is closed.

shutdownOutput

public void shutdownOutput()

Description copied from interface: EndPoint

Shutdown the output.

This call indicates that no more data will be sent on this endpoint that that the remote end should read an EOF once all previously sent data has been consumed. Shutdown may be done either at the TCP/IP level, as a protocol exchange (Eg TLS close handshake) or both.

If the endpoint has EndPoint.isInputShutdown() true, then this call has the same effect as EndPoint.close().

close

public void close()

Description copied from interface: EndPoint

Close any backing stream associated with the endpoint

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface EndPoint

Overrides:

close in class AbstractEndPoint

hasMore

public boolean hasMore()

Returns:

true if there are bytes remaining to be read from the encoded input

fill

public int fill(ByteBuffer buffer)
         throws IOException

Description copied from interface: EndPoint

Fill the passed buffer with data from this endpoint. The bytes are appended to any data already in the buffer by writing from the buffers limit up to it's capacity. The limit is updated to include the filled bytes.

Parameters:

buffer - The buffer to fill. The position and limit are modified during the fill. After the operation, the position is unchanged and the limit is increased to reflect the new data filled.

Returns:

an int value indicating the number of bytes filled or -1 if EOF is read or the input is shutdown.

Throws:

EofException - If the endpoint is closed.

IOException

flush

public boolean flush(ByteBuffer... buffers)
              throws IOException

Description copied from interface: EndPoint

Flush data from the passed header/buffer to this endpoint. As many bytes as can be consumed are taken from the header/buffer position up until the buffer limit. The header/buffers position is updated to indicate how many bytes have been consumed.

Returns:

True IFF all the buffers have been consumed and the endpoint has flushed the data to its destination (ie is not buffering any data).

Throws:

EofException - If the endpoint is closed or output is shutdown.

IOException

reset

public void reset()

getTransport

public Object getTransport()

Returns:

The underlying transport object (socket, channel, etc.)

isGrowOutput

public boolean isGrowOutput()

Returns:

the growOutput

setGrowOutput

public void setGrowOutput(boolean growOutput)

Parameters:

growOutput - the growOutput to set