org.glassfish.tyrus.websockets

Class ProtocolHandler

java.lang.Object

org.glassfish.tyrus.websockets.ProtocolHandler

Direct Known Subclasses:

Draft06Handler, Draft07Handler

public abstract class ProtocolHandler
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Connection	connection
protected byte	inFragmentedType
protected boolean	maskData
protected boolean	processingFragment

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProtocolHandler(boolean maskData)

Method Summary

Methods

Modifier and Type	Method and Description
protected byte	checkForLastFrame(DataFrame frame, byte opcode)
Future<DataFrame>	close(int code, String reason)
abstract HandShake	createClientHandShake(WebSocketRequest webSocketRequest, boolean client) Create HandShake on client side.
protected abstract HandShake	createHandShake(WebSocketRequest webSocketRequest) Create HandShake on server side.
protected long	decodeLength(byte[] bytes) Convert a byte[] to a long.
void	doClose()
protected byte[]	encodeLength(long length) Converts the length given to the appropriate framing data: 0-125 one element that is the payload length.
abstract byte[]	frame(DataFrame frame)
Connection	getConnection()
WebSocket	getWebSocket()
HandShake	handshake(Connection connection, WebSocketApplication app, WebSocketRequest request)
protected abstract boolean	isControlFrame(byte opcode)
boolean	isMaskData()
protected abstract DataFrame	parse(ByteBuffer buffer)
Future<DataFrame>	send(byte[] data)
Future<DataFrame>	send(DataFrame frame)
Future<DataFrame>	send(DataFrame frame, boolean useTimeout)
Future<DataFrame>	send(DataFrame frame, Connection.CompletionHandler<DataFrame> completionHandler, Boolean useTimeout)
Future<DataFrame>	send(String data)
void	setConnection(Connection handler)
void	setContainer(javax.websocket.WebSocketContainer container) Sets the container.
void	setWebSocket(WebSocket webSocket)
void	setWriteTimeout(long timeoutMs) Sets the timeout for the writing operation.
Future<DataFrame>	stream(boolean last, byte[] bytes, int off, int len)
Future<DataFrame>	stream(boolean last, String fragment)
DataFrame	unframe(ByteBuffer buffer)
protected void	utf8Decode(boolean finalFragment, byte[] data, DataFrame dataFrame)

Methods inherited from class java.lang.Object

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

Field Detail

maskData

protected final boolean maskData

connection

protected Connection connection

inFragmentedType

protected byte inFragmentedType

processingFragment

protected boolean processingFragment

Constructor Detail

ProtocolHandler

protected ProtocolHandler(boolean maskData)

Method Detail

handshake

public HandShake handshake(Connection connection,
                  WebSocketApplication app,
                  WebSocketRequest request)

send

public final Future<DataFrame> send(DataFrame frame,
                     boolean useTimeout)

send

public final Future<DataFrame> send(DataFrame frame)

send

public Future<DataFrame> send(DataFrame frame,
                     Connection.CompletionHandler<DataFrame> completionHandler,
                     Boolean useTimeout)

getConnection

public Connection getConnection()

setConnection

public void setConnection(Connection handler)

getWebSocket

public WebSocket getWebSocket()

setWebSocket

public void setWebSocket(WebSocket webSocket)

isMaskData

public boolean isMaskData()

frame

public abstract byte[] frame(DataFrame frame)

createHandShake

protected abstract HandShake createHandShake(WebSocketRequest webSocketRequest)

Create HandShake on server side.

Parameters:

webSocketRequest - representation of received initial HTTP request.

Returns:

new HandShake instance.

createClientHandShake

public abstract HandShake createClientHandShake(WebSocketRequest webSocketRequest,
                              boolean client)

Create HandShake on client side.

Parameters:

webSocketRequest - representation of HTTP request to be sent.

Returns:

new HandShake instance.

send

public Future<DataFrame> send(byte[] data)

send

public Future<DataFrame> send(String data)

stream

public Future<DataFrame> stream(boolean last,
                       byte[] bytes,
                       int off,
                       int len)

stream

public Future<DataFrame> stream(boolean last,
                       String fragment)

close

public Future<DataFrame> close(int code,
                      String reason)

unframe

public DataFrame unframe(ByteBuffer buffer)

parse

protected abstract DataFrame parse(ByteBuffer buffer)

decodeLength

protected long decodeLength(byte[] bytes)

Convert a byte[] to a long. Used for rebuilding payload length.

Parameters:

bytes - byte array to be converted.

Returns:

converted byte array.

encodeLength

protected byte[] encodeLength(long length)

Converts the length given to the appropriate framing data:

1. 0-125 one element that is the payload length.
2. up to 0xFFFF, 3 element array starting with 126 with the following 2 bytes interpreted as a 16 bit unsigned integer showing the payload length.
3. else 9 element array starting with 127 with the following 8 bytes interpreted as a 64-bit unsigned integer (the high bit must be 0) showing the payload length.

Parameters:

length - the payload size

Returns:

the array

isControlFrame

protected abstract boolean isControlFrame(byte opcode)

checkForLastFrame

protected byte checkForLastFrame(DataFrame frame,
                     byte opcode)

doClose

public void doClose()

utf8Decode

protected void utf8Decode(boolean finalFragment,
              byte[] data,
              DataFrame dataFrame)

setWriteTimeout

public void setWriteTimeout(long timeoutMs)

Sets the timeout for the writing operation.

Parameters:

timeoutMs - timeout in milliseconds.

setContainer

public void setContainer(javax.websocket.WebSocketContainer container)

Sets the container.

Parameters:

container - container.