Grizzly NIO 5.0.2 · org.glassfish.grizzly.websockets.ProtocolHandler

Field Summary

Modifier and Type	Field and Description
protected Connection<L>	connection
protected FilterChainContext	ctx
protected final CharsetDecoder	currentDecoder
protected byte	inFragmentedType
protected WebSocketMappingData	mappingData
protected final boolean	maskData
protected byte	outFragmentedType
protected boolean	processingFragment
protected ByteBuffer	remainder
protected final Charset	utf8
private WebSocket	webSocket

Constructor Summary

Access	Constructor and Description
public	ProtocolHandler(boolean maskData)

Method Summary

Modifier and Type	Method and Description
protected byte	checkForLastFrame(DataFrame frame, byte opcode)
public GrizzlyFuture<DataFrame>	close(int code, String reason)
public abstract HandShake	createClientHandShake(URI uri)
public abstract HandShake	createServerHandShake(HttpContent requestContent)
public long	decodeLength(byte[] bytes) Convert a byte[] to a long.
public void	doClose()
public byte[]	Returns: the array encodeLength(final long the payload size length) Converts the length given to the appropriate framing data: 0-125 one element that is the payload length. 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. 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.
public abstract byte[]	frame(DataFrame frame)
protected ByteBuffer	getByteBuffer(final byte[] data)
public Connection<L>	getConnection()
public FilterChainContext	getFilterChainContext()
protected WebSocketMappingData	getMappingData()
public WebSocket	getWebSocket()
public HandShake	handshake(FilterChainContext ctx, WebSocketApplication app, HttpContent request)
protected abstract boolean	isControlFrame(byte opcode)
public boolean	isMaskData()
public abstract DataFrame	parse(Buffer buffer)
public final GrizzlyFuture<DataFrame>	send(DataFrame frame)
public GrizzlyFuture<DataFrame>	send(DataFrame frame, CompletionHandler<DataFrame> completionHandler)
public GrizzlyFuture<DataFrame>	send(byte[] data)
public GrizzlyFuture<DataFrame>	send(String data)
public void	setConnection(Connection<L> handler)
public void	setFilterChainContext(FilterChainContext ctx)
protected void	setMappingData(final WebSocketMappingData mappingData)
public void	setWebSocket(WebSocket webSocket)
public GrizzlyFuture<DataFrame>	stream(boolean last, byte[] bytes, int off, int len)
public GrizzlyFuture<DataFrame>	stream(boolean last, String fragment)
public DataFrame	toDataFrame(String data)
public DataFrame	toDataFrame(byte[] data)
public DataFrame	toDataFrame(String data, boolean last)
public DataFrame	toDataFrame(byte[] data, boolean last)
public DataFrame	unframe(Buffer buffer)
protected void	utf8Decode(boolean finalFragment, byte[] data, DataFrame dataFrame)
protected void	validate(final byte fragmentType, byte opcode)
private GrizzlyFuture<DataFrame>	write(final DataFrame frame, final CompletionHandler<DataFrame> completionHandler)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

connection	back to summary
protected Connection<L> connection

ctx	back to summary
protected FilterChainContext ctx

currentDecoder	back to summary
protected final CharsetDecoder currentDecoder

inFragmentedType	back to summary
protected byte inFragmentedType

mappingData	back to summary
protected WebSocketMappingData mappingData

maskData	back to summary
protected final boolean maskData

outFragmentedType	back to summary
protected byte outFragmentedType

processingFragment	back to summary
protected boolean processingFragment

remainder	back to summary
protected ByteBuffer remainder

utf8	back to summary
protected final Charset utf8

webSocket	back to summary
private WebSocket webSocket

Constructor Detail

ProtocolHandler	back to summary
public ProtocolHandler(boolean maskData)

Method Detail

checkForLastFrame	back to summary
protected byte checkForLastFrame(DataFrame frame, byte opcode)

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

createClientHandShake	back to summary
public abstract HandShake createClientHandShake(URI uri)

createServerHandShake	back to summary
public abstract HandShake createServerHandShake(HttpContent requestContent)

decodeLength	back to summary
public long decodeLength(byte[] bytes) Convert a byte[] to a long. Used for rebuilding payload length.

doClose	back to summary
public void doClose()

encodeLength	back to summary
public byte[] encodeLength(final long length) Converts the length given to the appropriate framing data: 0-125 one element that is the payload length. 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. 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:long the payload size Returns:byte[] the array

encodeLength

back to summary

public byte[] encodeLength(final long length)

Converts the length given to the appropriate framing data:

0-125 one element that is the payload length.
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.
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:long: the payload size

Returns:byte[]

the array

frame	back to summary
public abstract byte[] frame(DataFrame frame)

getByteBuffer	back to summary
protected ByteBuffer getByteBuffer(final byte[] data)

getConnection	back to summary
public Connection<L> getConnection()

getFilterChainContext	back to summary
public FilterChainContext getFilterChainContext()

getMappingData	back to summary
protected WebSocketMappingData getMappingData()

getWebSocket	back to summary
public WebSocket getWebSocket()

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

isControlFrame	back to summary
protected abstract boolean isControlFrame(byte opcode)

isMaskData	back to summary
public boolean isMaskData()

parse	back to summary
public abstract DataFrame parse(Buffer buffer)

send	back to summary
public final GrizzlyFuture<DataFrame> send(DataFrame frame)

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

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

send	back to summary
public GrizzlyFuture<DataFrame> send(String data)

setConnection	back to summary
public void setConnection(Connection<L> handler)

setFilterChainContext	back to summary
public void setFilterChainContext(FilterChainContext ctx)

setMappingData	back to summary
protected void setMappingData(final WebSocketMappingData mappingData)

setWebSocket	back to summary
public void setWebSocket(WebSocket webSocket)

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

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

toDataFrame	back to summary
public DataFrame toDataFrame(String data)

toDataFrame	back to summary
public DataFrame toDataFrame(byte[] data)

toDataFrame	back to summary
public DataFrame toDataFrame(String data, boolean last)

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

unframe	back to summary
public DataFrame unframe(Buffer buffer)

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

validate	back to summary
protected void validate(final byte fragmentType, byte opcode)

write	back to summary
private GrizzlyFuture<DataFrame> write(final DataFrame frame, final CompletionHandler<DataFrame> completionHandler) Annotations @SuppressWarnings:unchecked

public abstract Class ProtocolHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail