org.eclipse.jetty.websocket.common

Class Generator

java.lang.Object

org.eclipse.jetty.websocket.common.Generator

public class Generator
extends Object

Generating a frame in WebSocket land.

    0                   1                   2                   3
    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
   +-+-+-+-+-------+-+-------------+-------------------------------+
   |F|R|R|R| opcode|M| Payload len |    Extended payload length    |
   |I|S|S|S|  (4)  |A|     (7)     |             (16/64)           |
   |N|V|V|V|       |S|             |   (if payload len==126/127)   |
   | |1|2|3|       |K|             |                               |
   +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
   |     Extended payload length continued, if payload len == 127  |
   + - - - - - - - - - - - - - - - +-------------------------------+
   |                               |Masking-key, if MASK set to 1  |
   +-------------------------------+-------------------------------+
   | Masking-key (continued)       |          Payload Data         |
   +-------------------------------- - - - - - - - - - - - - - - - +
   :                     Payload Data continued ...                :
   + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
   |                     Payload Data continued ...                |
   +---------------------------------------------------------------+
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	OVERHEAD The overhead (maximum) for a framing header.

Constructor Summary

Constructors

Constructor and Description
Generator(WebSocketPolicy policy, ByteBufferPool bufferPool) Construct Generator with provided policy and bufferPool
Generator(WebSocketPolicy policy, ByteBufferPool bufferPool, boolean validating) Construct Generator with provided policy and bufferPool

Method Summary

Methods

Modifier and Type	Method and Description
void	assertFrameValid(Frame frame)
void	configureFromExtensions(List<? extends Extension> exts)
ByteBuffer	generate(Frame frame) generate a byte buffer based on the frame being passed in bufferSize is determined by the length of the payload + 28 for frame overhead
ByteBuffer	generate(int windowSize, Frame frame) Generate, into a ByteBuffer, no more than bufferSize of contents from the frame.
ByteBufferPool	getBufferPool()
boolean	isRsv1InUse()
boolean	isRsv2InUse()
boolean	isRsv3InUse()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

OVERHEAD

public static final int OVERHEAD

The overhead (maximum) for a framing header. Assuming a maximum sized payload with masking key.

See Also:

Constant Field Values

Constructor Detail

Generator

public Generator(WebSocketPolicy policy,
         ByteBufferPool bufferPool)

Construct Generator with provided policy and bufferPool

Parameters:

policy - the policy to use

bufferPool - the buffer pool to use

Generator

public Generator(WebSocketPolicy policy,
         ByteBufferPool bufferPool,
         boolean validating)

Construct Generator with provided policy and bufferPool

Parameters:

policy - the policy to use

bufferPool - the buffer pool to use

validating - true to enable RFC frame validation

Method Detail

assertFrameValid

public void assertFrameValid(Frame frame)

configureFromExtensions

public void configureFromExtensions(List<? extends Extension> exts)

generate

public ByteBuffer generate(Frame frame)

generate a byte buffer based on the frame being passed in bufferSize is determined by the length of the payload + 28 for frame overhead

Parameters:

frame -

Returns:

generate

public ByteBuffer generate(int windowSize,
                  Frame frame)

Generate, into a ByteBuffer, no more than bufferSize of contents from the frame. If the frame exceeds the bufferSize, then multiple calls to #generate(int, WebSocketFrame) are required to obtain each window of ByteBuffer to complete the frame.

getBufferPool

public ByteBufferPool getBufferPool()

isRsv1InUse

public boolean isRsv1InUse()

isRsv2InUse

public boolean isRsv2InUse()

isRsv3InUse

public boolean isRsv3InUse()

toString

public String toString()

Overrides:

toString in class Object