org.glassfish.grizzly.websockets

Class ProtocolHandler

java.lang.Object

org.glassfish.grizzly.websockets.ProtocolHandler

Direct Known Subclasses:

RFC6455Handler

public abstract class ProtocolHandler
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Connection	connection
protected FilterChainContext	ctx
protected CharsetDecoder	currentDecoder
protected byte	inFragmentedType
protected WebSocketMappingData	mappingData
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

Modifier and Type	Method and Description
protected byte	checkForLastFrame(DataFrame frame, byte opcode)
GrizzlyFuture<DataFrame>	close(int code, String reason)
abstract HandShake	createClientHandShake(URI uri)
abstract HandShake	createServerHandShake(HttpContent requestContent)
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()
FilterChainContext	getFilterChainContext()
protected WebSocketMappingData	getMappingData()
WebSocket	getWebSocket()
HandShake	handshake(FilterChainContext ctx, WebSocketApplication app, HttpContent request)
protected abstract boolean	isControlFrame(byte opcode)
boolean	isMaskData()
abstract DataFrame	parse(Buffer buffer)
GrizzlyFuture<DataFrame>	send(byte[] data)
GrizzlyFuture<DataFrame>	send(DataFrame frame)
GrizzlyFuture<DataFrame>	send(DataFrame frame, CompletionHandler<DataFrame> completionHandler)
GrizzlyFuture<DataFrame>	send(String data)
void	setConnection(Connection handler)
void	setFilterChainContext(FilterChainContext ctx)
protected void	setMappingData(WebSocketMappingData mappingData)
void	setWebSocket(WebSocket webSocket)
GrizzlyFuture<DataFrame>	stream(boolean last, byte[] bytes, int off, int len)
GrizzlyFuture<DataFrame>	stream(boolean last, String fragment)
DataFrame	toDataFrame(byte[] data)
DataFrame	toDataFrame(byte[] data, boolean last)
DataFrame	toDataFrame(String data)
DataFrame	toDataFrame(String data, boolean last)
DataFrame	unframe(Buffer 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

ctx

protected FilterChainContext ctx

processingFragment

protected boolean processingFragment

utf8

protected final Charset utf8

currentDecoder

protected final CharsetDecoder currentDecoder

remainder

protected ByteBuffer remainder

mappingData

protected WebSocketMappingData mappingData

Constructor Detail

ProtocolHandler

public ProtocolHandler(boolean maskData)

Method Detail

handshake

public HandShake handshake(FilterChainContext ctx,
                           WebSocketApplication app,
                           HttpContent request)

send

public final GrizzlyFuture<DataFrame> send(DataFrame frame)

send

public GrizzlyFuture<DataFrame> send(DataFrame frame,
                                     CompletionHandler<DataFrame> completionHandler)

getConnection

public Connection getConnection()

setConnection

public void setConnection(Connection handler)

getFilterChainContext

public FilterChainContext getFilterChainContext()

setFilterChainContext

public void setFilterChainContext(FilterChainContext ctx)

getMappingData

protected WebSocketMappingData getMappingData()

setMappingData

protected void setMappingData(WebSocketMappingData mappingData)

getWebSocket

public WebSocket getWebSocket()

setWebSocket

public void setWebSocket(WebSocket webSocket)

isMaskData

public boolean isMaskData()

frame

public abstract byte[] frame(DataFrame frame)

toDataFrame

public DataFrame toDataFrame(String data)

toDataFrame

public DataFrame toDataFrame(byte[] data)

toDataFrame

public DataFrame toDataFrame(String data,
                             boolean last)

toDataFrame

public DataFrame toDataFrame(byte[] data,
                             boolean last)

createServerHandShake

public abstract HandShake createServerHandShake(HttpContent requestContent)

createClientHandShake

public abstract HandShake createClientHandShake(URI uri)

send

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

send

public GrizzlyFuture<DataFrame> send(String data)

stream

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

stream

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

close

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

unframe

public DataFrame unframe(Buffer buffer)

parse

public abstract DataFrame parse(Buffer buffer)

decodeLength

public long decodeLength(byte[] bytes)

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

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)