Package 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:

java.io.Closeable, java.lang.AutoCloseable, EndPoint

public class ByteArrayEndPoint
extends AbstractEndPoint

ByteArrayEndPoint.

Field Summary

Fields

Modifier and Type	Field	Description
static java.net.InetSocketAddress	NOIP

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addInput(java.lang.String s)
void	addInput(java.lang.String s, java.nio.charset.Charset charset)
void	addInput(java.nio.ByteBuffer in)
void	addInputAndExecute(java.nio.ByteBuffer in)
void	addInputEOF()
void	close()	Close any backing stream associated with the endpoint
protected void	execute(java.lang.Runnable task)
int	fill(java.nio.ByteBuffer buffer)	Fill the passed buffer with data from this endpoint.
boolean	flush(java.nio.ByteBuffer... buffers)	Flush data from the passed header/buffer to this endpoint.
java.nio.ByteBuffer	getOutput()
java.lang.String	getOutputString()
java.lang.String	getOutputString(java.nio.charset.Charset charset)
java.lang.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 void	needsFillInterest()
protected void	onIncompleteFlush()
void	reset()
void	setGrowOutput(boolean growOutput)
void	setOutput(java.nio.ByteBuffer out)
void	shutdownInput()
void	shutdownOutput()	Shutdown the output.
java.nio.ByteBuffer	takeOutput()
java.lang.String	takeOutputString()
java.lang.String	takeOutputString(java.nio.charset.Charset charset)
java.lang.String	toString()
java.nio.ByteBuffer	waitForOutput(long time, java.util.concurrent.TimeUnit unit)	Wait for some output

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

close, fillInterested, getConnection, getCreatedTimeStamp, getFillInterest, getLocalAddress, getRemoteAddress, getWriteFlusher, isFillInterested, isOptimizedForDirectBuffers, onIdleExpired, onOpen, setConnection, tryFillInterested, upgrade, write

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

getIdleTimeout, onClose, setIdleTimeout

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

checkIdleTimeout, getIdleFor, getIdleTimeout, getIdleTimestamp, getScheduler, notIdle, onClose, setIdleTimeout

Methods inherited from class java.lang.Object

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

Field Detail

NOIP

public static final java.net.InetSocketAddress NOIP

Constructor Detail

ByteArrayEndPoint

public ByteArrayEndPoint()

ByteArrayEndPoint

public ByteArrayEndPoint(byte[] input,
                         int outputSize)

Parameters:

input - the input bytes

outputSize - the output size

ByteArrayEndPoint

public ByteArrayEndPoint(java.lang.String input,
                         int outputSize)

Parameters:

input - the input string (converted to bytes using default encoding charset)

outputSize - the output size

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,
                         java.lang.String input,
                         int outputSize)

ByteArrayEndPoint

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

Method Detail

onIncompleteFlush

protected void onIncompleteFlush()

Specified by:

onIncompleteFlush in class AbstractEndPoint

execute

protected void execute(java.lang.Runnable task)

needsFillInterest

protected void needsFillInterest()
                          throws java.io.IOException

Specified by:

needsFillInterest in class AbstractEndPoint

Throws:

java.io.IOException

addInputEOF

public void addInputEOF()

addInput

public void addInput(java.nio.ByteBuffer in)

Parameters:

in - The in to set.

addInputAndExecute

public void addInputAndExecute(java.nio.ByteBuffer in)

addInput

public void addInput(java.lang.String s)

addInput

public void addInput(java.lang.String s,
                     java.nio.charset.Charset charset)

getOutput

public java.nio.ByteBuffer getOutput()

Returns:

Returns the out.

getOutputString

public java.lang.String getOutputString()

Returns:

Returns the out.

getOutputString

public java.lang.String getOutputString(java.nio.charset.Charset charset)

Parameters:

charset - the charset to encode the output as

Returns:

Returns the out.

takeOutput

public java.nio.ByteBuffer takeOutput()

Returns:

Returns the out.

waitForOutput

public java.nio.ByteBuffer waitForOutput(long time,
                                         java.util.concurrent.TimeUnit unit)
                                  throws java.lang.InterruptedException

Wait for some output

Parameters:

time - Time to wait

unit - Units for time to wait

Returns:

The buffer of output

Throws:

java.lang.InterruptedException

takeOutputString

public java.lang.String takeOutputString()

Returns:

Returns the out.

takeOutputString

public java.lang.String takeOutputString(java.nio.charset.Charset charset)

Parameters:

charset - the charset to encode the output as

Returns:

Returns the out.

setOutput

public void setOutput(java.nio.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.

shutdownInput

public void shutdownInput()

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 java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

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(java.nio.ByteBuffer buffer)
         throws java.io.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:

java.io.IOException - if the endpoint is closed.

flush

public boolean flush(java.nio.ByteBuffer... buffers)
              throws java.io.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.

Parameters:

buffers - the buffers to flush

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:

java.io.IOException - If the endpoint is closed or output is shutdown.

reset

public void reset()

getTransport

public java.lang.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

toString

public java.lang.String toString()

Overrides:

toString in class AbstractEndPoint