Module org.eclipse.jetty.io

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:

Closeable, AutoCloseable, Content.Sink, EndPoint

public class ByteArrayEndPoint
extends AbstractEndPoint

ByteArrayEndPoint.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.EndPoint

EndPoint.Pipe, EndPoint.SslSessionData, EndPoint.Wrapper

Constructor Summary

Constructors

Constructor	Description
ByteArrayEndPoint()
ByteArrayEndPoint(byte[] input, int outputSize)
ByteArrayEndPoint(byte[] input, int outputSize, boolean growable)
ByteArrayEndPoint(String input, int outputSize)
ByteArrayEndPoint(String input, int outputSize, boolean growable)
ByteArrayEndPoint(org.eclipse.jetty.util.thread.Scheduler scheduler, long idleTimeoutMs)
ByteArrayEndPoint(org.eclipse.jetty.util.thread.Scheduler timer, long idleTimeoutMs, byte[] input, int outputSize)
ByteArrayEndPoint(org.eclipse.jetty.util.thread.Scheduler timer, long idleTimeoutMs, String input, int outputSize)
ByteArrayEndPoint(org.eclipse.jetty.util.thread.Scheduler timer, long idleTimeoutMs, ByteBuffer input, int outputSize, boolean growable)

Method Summary

Modifier and Type	Method	Description
void	addInput(String s)
void	addInput(String s, Charset charset)
void	addInput(ByteBuffer in)
void	addInputAndExecute(String s)
void	addInputAndExecute(ByteBuffer in)
void	addInputEOF()
void	doClose()
void	doShutdownOutput()
protected void	execute(Runnable task)
int	fill(ByteBuffer buffer)	Fills the passed buffer with data from this endpoint.
boolean	flush(ByteBuffer... buffers)	Flushes data from the passed header/buffer to this endpoint.
SocketAddress	getLocalSocketAddress()
ByteBuffer	getOutput()
String	getOutputString()
String	getOutputString(Charset charset)
SocketAddress	getRemoteSocketAddress()
Object	getTransport()
boolean	hasMore()
boolean	isGrowOutput()
protected void	needsFillInterest()
protected void	onIncompleteFlush()
void	reset()
void	setGrowOutput(boolean growOutput)	Deprecated.
void	setOutput(ByteBuffer out)	Deprecated.
ByteBuffer	takeOutput()
String	takeOutputString()
String	takeOutputString(Charset charset)
String	toString()
ByteBuffer	waitForOutput(long time, TimeUnit unit)	Wait for some output

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

cancelWrite, close, close, doShutdownInput, fillInterested, getConnection, getCreatedTimeStamp, getFillInterest, getWriteFlusher, isFillInterested, isInputShutdown, isOpen, isOutputShutdown, onClose, onClose, onIdleExpired, onOpen, setConnection, shutdownInput, shutdownOutput, toConnectionString, toEndPointString, tryFillInterested, upgrade, write

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

checkIdleTimeout, getIdleFor, getIdleTimeout, getScheduler, 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, getSslSessionData, isSecure, receive, send, setIdleTimeout, write, write

Constructor Details

ByteArrayEndPoint

public ByteArrayEndPoint()

ByteArrayEndPoint

public ByteArrayEndPoint(byte[] input,
 int outputSize)

Parameters:

input - the input bytes

outputSize - the output size or -1 for default

ByteArrayEndPoint

public ByteArrayEndPoint(String input,
 int outputSize)

Parameters:

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

outputSize - the output size or -1 for default

ByteArrayEndPoint

public ByteArrayEndPoint(byte[] input,
 int outputSize,
 boolean growable)

Parameters:

input - the input bytes

outputSize - the output size or -1 for default

growable - true if the output buffer may grow

ByteArrayEndPoint

public ByteArrayEndPoint(String input,
 int outputSize,
 boolean growable)

Parameters:

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

outputSize - the output size or -1 for default

growable - true if the output buffer may grow

ByteArrayEndPoint

public ByteArrayEndPoint(org.eclipse.jetty.util.thread.Scheduler scheduler,
 long idleTimeoutMs)

ByteArrayEndPoint

public ByteArrayEndPoint(org.eclipse.jetty.util.thread.Scheduler timer,
 long idleTimeoutMs,
 byte[] input,
 int outputSize)

ByteArrayEndPoint

public ByteArrayEndPoint(org.eclipse.jetty.util.thread.Scheduler timer,
 long idleTimeoutMs,
 String input,
 int outputSize)

ByteArrayEndPoint

public ByteArrayEndPoint(org.eclipse.jetty.util.thread.Scheduler timer,
 long idleTimeoutMs,
 ByteBuffer input,
 int outputSize,
 boolean growable)

Method Details

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Specified by:

getLocalSocketAddress in interface EndPoint

Specified by:

getLocalSocketAddress in class AbstractEndPoint

Returns:

the local SocketAddress to which this EndPoint is bound or null if this EndPoint is not bound to a Socket address.

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Specified by:

getRemoteSocketAddress in interface EndPoint

Specified by:

getRemoteSocketAddress in class AbstractEndPoint

Returns:

The remote SocketAddress to which this EndPoint is connected, or null if this EndPoint is not connected to a Socket address.

doShutdownOutput

public void doShutdownOutput()

Overrides:

doShutdownOutput in class AbstractEndPoint

doClose

public void doClose()

Overrides:

doClose in class AbstractEndPoint

onIncompleteFlush

protected void onIncompleteFlush()

Specified by:

onIncompleteFlush in class AbstractEndPoint

execute

protected void execute(Runnable task)

needsFillInterest

protected void needsFillInterest()
                          throws IOException

Specified by:

needsFillInterest in class AbstractEndPoint

Throws:

IOException

addInputEOF

public void addInputEOF()

addInput

public void addInput(ByteBuffer in)

Parameters:

in - The in to set.

addInput

public void addInput(String s)

addInput

public void addInput(String s,
 Charset charset)

addInputAndExecute

public void addInputAndExecute(String s)

addInputAndExecute

public void addInputAndExecute(ByteBuffer in)

getOutput

public ByteBuffer getOutput()

Returns:

Returns the out.

getOutputString

public String getOutputString()

Returns:

Returns the out.

getOutputString

public String getOutputString(Charset charset)

Parameters:

charset - the charset to encode the output as

Returns:

Returns the out.

takeOutput

public ByteBuffer takeOutput()

Returns:

Returns the out.

waitForOutput

public ByteBuffer waitForOutput(long time,
 TimeUnit unit)
                         throws InterruptedException

Wait for some output

Parameters:

time - Time to wait

unit - Units for time to wait

Returns:

The buffer of output

Throws:

InterruptedException - if interrupted

takeOutputString

public String takeOutputString()

Returns:

Returns the out.

takeOutputString

public String takeOutputString(Charset charset)

Parameters:

charset - the charset to encode the output as

Returns:

Returns the out.

setOutput

@Deprecated
public void setOutput(ByteBuffer out)

Deprecated.

Parameters:

out - The out to set.

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

Fills 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 its 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:

IOException - if the endpoint is closed.

flush

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

Description copied from interface: EndPoint

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

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

reset

public void reset()

Overrides:

reset in class AbstractEndPoint

getTransport

public Object getTransport()

Returns:

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

isGrowOutput

public boolean isGrowOutput()

Returns:

the growOutput

setGrowOutput

@Deprecated
public void setGrowOutput(boolean growOutput)

Deprecated.

Set the growOutput to set.

Parameters:

growOutput - the growOutput to set

toString

public String toString()

Overrides:

toString in class AbstractEndPoint