org.eclipse.jetty.websocket.common.io

Class WriteBytesProvider

java.lang.Object

org.eclipse.jetty.websocket.common.io.WriteBytesProvider

All Implemented Interfaces:

Callback

public class WriteBytesProvider
extends Object
implements Callback

Interface for working with bytes destined for EndPoint.write(Callback, ByteBuffer...)

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Callback

Callback.Adapter

Constructor Summary

Constructors

Constructor and Description
WriteBytesProvider(Generator generator, Callback flushCallback) Create a WriteBytesProvider with specified Generator and "flush" Callback.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Force closure of write bytes
void	enqueue(Frame frame, Callback callback)
void	failAll(Throwable t)
void	failed(Throwable cause) Callback failure.
int	getBufferSize()
List<ByteBuffer>	getByteBuffers() Get the next set of ByteBuffers to write.
boolean	isClosed() Used to test for the final frame possible to be enqueued, the CLOSE frame.
void	releasePayloadBuffer(Frame frame)
void	setBufferSize(int bufferSize) Set the buffer size used for generating ByteBuffers from the frames.
void	succeeded() Write of ByteBuffer succeeded.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteBytesProvider

public WriteBytesProvider(Generator generator,
                  Callback flushCallback)

Create a WriteBytesProvider with specified Generator and "flush" Callback.

Parameters:

generator - the generator to use for converting Frame objects to network ByteBuffers

flushCallback - the flush callback to call, on a write event, after the write event has been processed by this WriteBytesProvider.

Used to trigger another flush of the next set of bytes.

Method Detail

close

public void close()

Force closure of write bytes

enqueue

public void enqueue(Frame frame,
           Callback callback)

failAll

public void failAll(Throwable t)

failed

public void failed(Throwable cause)

Callback failure.

Conditions: for Endpoint.write() failure.

Specified by:

failed in interface Callback

Parameters:

cause - the cause of the failure

getBufferSize

public int getBufferSize()

getByteBuffers

public List<ByteBuffer> getByteBuffers()

Get the next set of ByteBuffers to write.

Returns:

the next set of ByteBuffers to write

isClosed

public boolean isClosed()

Used to test for the final frame possible to be enqueued, the CLOSE frame.

Returns:

true if close frame has been enqueued already.

releasePayloadBuffer

public void releasePayloadBuffer(Frame frame)

setBufferSize

public void setBufferSize(int bufferSize)

Set the buffer size used for generating ByteBuffers from the frames.

Value usually obtained from AbstractConnection.getInputBufferSize()

Parameters:

bufferSize - the buffer size to use

succeeded

public void succeeded()

Write of ByteBuffer succeeded.

Specified by:

succeeded in interface Callback

toString

public String toString()

Overrides:

toString in class Object