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 CharsetDecoder	currentDecoder
protected byte	inFragmentedType
protected boolean	maskData
protected byte	outFragmentedType
protected boolean	processingFragment
protected ByteBuffer	remainder
protected Charset	utf8

Constructor Summary

Constructors

Constructor and Description
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	createHandShake(URI uri) Client side.
abstract HandShake	createHandShake(WebSocketRequest requestContent) Server side.
long	decodeLength(byte[] bytes) Convert a byte[] to a long.
void	doClose()
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)
protected ByteBuffer	getByteBuffer(byte[] data)
Connection	getConnection()
WebSocket	getWebSocket()
HandShake	handshake(Connection connection, WebSocketApplication app, WebSocketRequest request)
protected abstract boolean	isControlFrame(byte opcode)
boolean	isMaskData()
abstract DataFrame	parse(ByteBuffer buffer)
Future<DataFrame>	send(byte[] data)
Future<DataFrame>	send(DataFrame frame)
Future<DataFrame>	send(DataFrame frame, Connection.CompletionHandler<DataFrame> completionHandler)
Future<DataFrame>	send(String data)
void	setConnection(Connection handler)
void	setWebSocket(WebSocket webSocket)
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)
protected void	validate(byte fragmentType, byte opcode)

Methods inherited from class java.lang.Object

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

Field Detail

connection

protected Connection connection

inFragmentedType

protected byte inFragmentedType

outFragmentedType

protected byte outFragmentedType

maskData

protected final boolean maskData

processingFragment

protected boolean processingFragment

utf8

protected Charset utf8

currentDecoder

protected CharsetDecoder currentDecoder

remainder

protected ByteBuffer remainder

Constructor Detail

ProtocolHandler

public ProtocolHandler(boolean maskData)

Method Detail

handshake

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

send

public final Future<DataFrame> send(DataFrame frame)

send

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

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

public abstract HandShake createHandShake(WebSocketRequest requestContent)

Server side.

Parameters:

requestContent - TODO

Returns:

TODO

createHandShake

public abstract HandShake createHandShake(URI uri)

Client side.

Parameters:

uri - TODO

Returns:

TODO

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

public abstract DataFrame parse(ByteBuffer buffer)

decodeLength

public long decodeLength(byte[] bytes)

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

Parameters:

bytes - TODO

Returns:

TODO

encodeLength

public 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

validate

protected void validate(byte fragmentType,
            byte opcode)

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)

getByteBuffer

protected ByteBuffer getByteBuffer(byte[] data)