Modifier and Type	Class and Description
private static class	ProtocolHandler.CompletionHandlerWrapper Handler passed to the `org.glassfish.tyrus.spi.Writer`.
private static class	ProtocolHandler.ParsingState
private static enum	ProtocolHandler.SendingFragmentState Sending state.

Field Summary

Modifier and Type	Field and Description
private final boolean	client
private static final WriterInfo	CLOSE
private volatile ExtendedExtension.ExtensionContext	extensionContext
private volatile List<Extension>	extensions
private volatile boolean	hasExtensions
private final Condition	idleCondition If partial message is being send and we want to send partial message with different type or other whole message, we need to wait until "idleCondition" is signalled.
private volatile byte	inFragmentedType
private final Lock	lock Synchronizes all public send* (including stream variants) methods.
private static final Logger	LOGGER
public static final int	MASK_SIZE RFC 6455
private final MaskingKeyGenerator	maskingKeyGenerator
private volatile MessageEventListener	messageEventListener
private static final WriterInfo	NULL_INFO
private volatile byte	outFragmentedType
private final ProtocolHandler.ParsingState	parsingState
private volatile boolean	processingFragment
private volatile ByteBuffer	remainder
private static final int	SEND_TIMEOUT
private volatile ProtocolHandler.SendingFragmentState	sendingFragment
private volatile String	subProtocol
private volatile TyrusWebSocket	webSocket
private volatile Writer	writer

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
pack-priv	ProtocolHandler(boolean `true` when this instance is on client side, `false` when on server side. client, MaskingKeyGenerator random number generator that will be used for generating masking keys. Masking keys are required only on the client side and `maskingKeyGenerator` should be `null` on the server side. If `null` on the client side, `java.security.SecureRandom` will be used by default. maskingKeyGenerator) Constructor.

pack-priv

ProtocolHandler(boolean

true when this instance is on client side, false when on server side.

client, MaskingKeyGenerator

random number generator that will be used for generating masking keys. Masking keys are required only on the client side and maskingKeyGenerator should be null on the server side. If null on the client side, java.security.SecureRandom will be used by default.

maskingKeyGenerator)

Constructor.

Method Summary

Modifier and Type	Method and Description
private byte	checkForLastFrame(Frame frame)
private void	checkSendingFragment() Check whether current `ProtocolHandler` is sending a partial message.
public synchronized Future<Frame>	close(final int code, final String reason)
private long	Returns: converted byte array. decodeLength(byte[] byte array to be converted. bytes) Convert a byte[] to a long.
pack-priv void	doClose()
private 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.
pack-priv ByteBuffer	frame(Frame frame)
pack-priv List<Extension>	getExtensions()
pack-priv String	getSubProtocol()
public Handshake	Returns: server handshake object. handshake(TyrusEndpointWrapper endpoint related to the handshake (path is already matched). endpointWrapper, UpgradeRequest handshake request. request, UpgradeResponse handshake response. response, ExtendedExtension.ExtensionContext extension context. extensionContext) Server side handshake processing.
public boolean	Returns: `true` if there is at least one negotiated extension associated to this connection, `false` otherwise. hasExtensions() Returns true when current connection has some negotiated extension.
private boolean	isBitSet(final byte b, int bit)
private boolean	isControlFrame(byte opcode)
public void	process(Frame TODO. frame, TyrusWebSocket TODO. socket) TODO.
pack-priv final Future<Frame>	send(TyrusFrame frame, WriterInfo writerInfo) Not message frames - ping/pong/...
private Future<Frame>	send(TyrusFrame frame, CompletionHandler<Frame> completionHandler, WriterInfo writerInfo, Boolean useTimeout)
private Future<Frame>	send(ByteBuffer frame, CompletionHandler<Frame> completionHandler, WriterInfo writerInfo, Boolean useTimeout)
public Future<Frame>	send(byte[] data) Deprecated
public Future<Frame>	send(byte[] data, WriterInfo writerInfo)
public void	send(final byte[] data, final SendHandler handler) Deprecated
public void	send(final byte[] data, final SendHandler handler, WriterInfo writerInfo)
public Future<Frame>	send(String data) Deprecated
public Future<Frame>	send(String data, WriterInfo writerInfo)
public void	send(final String data, final SendHandler handler) Deprecated
public void	send(final String data, final SendHandler handler, WriterInfo writerInfo)
public Future<Frame>	Returns: send future. sendRawFrame(ByteBuffer serialized frame. data) Raw frame is always whole (not partial).
public void	setExtensionContext(ExtendedExtension.ExtensionContext extension context. extensionContext) Client side.
public void	setExtensions(List<Extension> list of negotiated extensions. Can be `null`. extensions) Client side.
public void	setMessageEventListener(MessageEventListener message event listener. messageEventListener) Set message event listener.
public void	setWebSocket(TyrusWebSocket client WebSocket connection. webSocket) Client side.
public void	setWriter(Writer `Writer` to be set. writer) Set `Writer` instance.
public Future<Frame>	stream(boolean last, byte[] bytes, int off, int len) Deprecated
public Future<Frame>	stream(boolean last, byte[] bytes, int off, int len, WriterInfo writerInfo)
public Future<Frame>	stream(boolean last, String fragment) Deprecated
public Future<Frame>	stream(boolean last, String fragment, WriterInfo writerInfo)
public Frame	Returns: TODO. unframe(ByteBuffer TODO. buffer) TODO!
private void	validate(final byte fragmentType, byte opcode)
private Future<Frame>	write(final TyrusFrame frame, final CompletionHandler<Frame> completionHandler, WriterInfo data, boolean useTimeout)
private Future<Frame>	write(final ByteBuffer frame, final CompletionHandler<Frame> completionHandler, WriterInfo data, boolean useTimeout)

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

Field Detail

client	back to summary
private final boolean client

CLOSE	back to summary
private static final WriterInfo CLOSE

extensionContext	back to summary
private volatile ExtendedExtension.ExtensionContext extensionContext

extensions	back to summary
private volatile List<Extension> extensions

hasExtensions	back to summary
private volatile boolean hasExtensions

idleCondition	back to summary
private final Condition idleCondition If partial message is being send and we want to send partial message with different type or other whole message, we need to wait until "idleCondition" is signalled.

inFragmentedType	back to summary
private volatile byte inFragmentedType

lock	back to summary
private final Lock lock Synchronizes all public send* (including stream variants) methods. The reason for this lock is that we need to have consistent value in {#sendingFragment} field to be able to determine the sending state of this particular instance/session.

lock

back to summary

private final Lock lock

Synchronizes all public send* (including stream variants) methods.

The reason for this lock is that we need to have consistent value in {#sendingFragment} field to be able to determine the sending state of this particular instance/session.

LOGGER	back to summary
private static final Logger LOGGER

MASK_SIZE	back to summary
public static final int MASK_SIZE RFC 6455

maskingKeyGenerator	back to summary
private final MaskingKeyGenerator maskingKeyGenerator

messageEventListener	back to summary
private volatile MessageEventListener messageEventListener

NULL_INFO	back to summary
private static final WriterInfo NULL_INFO

outFragmentedType	back to summary
private volatile byte outFragmentedType

parsingState	back to summary
private final ProtocolHandler.ParsingState parsingState

processingFragment	back to summary
private volatile boolean processingFragment

remainder	back to summary
private volatile ByteBuffer remainder

SEND_TIMEOUT	back to summary
private static final int SEND_TIMEOUT

sendingFragment	back to summary
private volatile ProtocolHandler.SendingFragmentState sendingFragment

subProtocol	back to summary
private volatile String subProtocol

webSocket	back to summary
private volatile TyrusWebSocket webSocket

writer	back to summary
private volatile Writer writer

Constructor Detail

ProtocolHandler back to summary

ProtocolHandler	back to summary
pack-priv ProtocolHandler(boolean client, MaskingKeyGenerator maskingKeyGenerator) Constructor. Parameters client:boolean `true` when this instance is on client side, `false` when on server side. maskingKeyGenerator:MaskingKeyGenerator random number generator that will be used for generating masking keys. Masking keys are required only on the client side and `maskingKeyGenerator` should be `null` on the server side. If `null` on the client side, `java.security.SecureRandom` will be used by default.

pack-priv ProtocolHandler(boolean client, MaskingKeyGenerator maskingKeyGenerator)

Constructor.

Parameters

client:boolean: true when this instance is on client side, false when on server side.
maskingKeyGenerator:MaskingKeyGenerator: random number generator that will be used for generating masking keys. Masking keys are required only on the client side and maskingKeyGenerator should be null on the server side. If null on the client side, java.security.SecureRandom will be used by default.

Method Detail

checkForLastFrame	back to summary
private byte checkForLastFrame(Frame frame)

checkSendingFragment back to summary

checkSendingFragment	back to summary
private void checkSendingFragment() Check whether current `ProtocolHandler` is sending a partial message. If yes, wait for 3000 and if the message still cannot be sent, throw `IllegalStateException`.

private void checkSendingFragment()

Check whether current ProtocolHandler is sending a partial message.

If yes, wait for 3000 and if the message still cannot be sent, throw IllegalStateException.

close	back to summary
public synchronized Future<Frame> close(final int code, final String reason)

decodeLength	back to summary
private long decodeLength(byte[] bytes) Convert a byte[] to a long. Used for rebuilding payload length. Parameters bytes:byte[] byte array to be converted. Returns:long converted byte array.

decodeLength

back to summary

private long decodeLength(byte[] bytes)

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

Parameters

bytes:byte[]: byte array to be converted.

Returns:long

converted byte array.

doClose	back to summary
pack-priv void doClose()

encodeLength	back to summary
private 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

private 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
pack-priv ByteBuffer frame(Frame frame)

getExtensions	back to summary
pack-priv List<Extension> getExtensions()

getSubProtocol	back to summary
pack-priv String getSubProtocol()

handshake back to summary

handshake	back to summary
public Handshake handshake(TyrusEndpointWrapper endpointWrapper, UpgradeRequest request, UpgradeResponse response, ExtendedExtension.ExtensionContext extensionContext) throws HandshakeException Server side handshake processing. Parameters endpointWrapper:TyrusEndpointWrapper endpoint related to the handshake (path is already matched). request:UpgradeRequest handshake request. response:UpgradeResponse handshake response. extensionContext:ExtendedExtension.ExtensionContext extension context. Returns:Handshake server handshake object. Exceptions HandshakeException: when there is problem with received `UpgradeRequest`.

public Handshake handshake(TyrusEndpointWrapper endpointWrapper, UpgradeRequest request, UpgradeResponse response, ExtendedExtension.ExtensionContext extensionContext) throws HandshakeException

Server side handshake processing.

Parameters

endpointWrapper:TyrusEndpointWrapper: endpoint related to the handshake (path is already matched).
request:UpgradeRequest: handshake request.
response:UpgradeResponse: handshake response.
extensionContext:ExtendedExtension.ExtensionContext: extension context.

Returns:Handshake

server handshake object.

Exceptions

HandshakeException:: when there is problem with received UpgradeRequest.

hasExtensions back to summary

hasExtensions	back to summary
public boolean hasExtensions() Returns true when current connection has some negotiated extension. Returns:boolean `true` if there is at least one negotiated extension associated to this connection, `false` otherwise.

public boolean hasExtensions()

Returns true when current connection has some negotiated extension.

Returns:boolean: true if there is at least one negotiated extension associated to this connection, false otherwise.

isBitSet	back to summary
private boolean isBitSet(final byte b, int bit)

isControlFrame	back to summary
private boolean isControlFrame(byte opcode)

process	back to summary
public void process(Frame frame, TyrusWebSocket socket) TODO. called after Extension execution. validates frame + processes its content Parameters frame:Frame TODO. socket:TyrusWebSocket TODO.

process

back to summary

public void process(Frame frame, TyrusWebSocket socket)

TODO.

called after Extension execution.

validates frame + processes its content

Parameters

frame:Frame: TODO.
socket:TyrusWebSocket: TODO.

send	back to summary
pack-priv final Future<Frame> send(TyrusFrame frame, WriterInfo writerInfo) Not message frames - ping/pong/...

send	back to summary
private Future<Frame> send(TyrusFrame frame, CompletionHandler<Frame> completionHandler, WriterInfo writerInfo, Boolean useTimeout)

send	back to summary
private Future<Frame> send(ByteBuffer frame, CompletionHandler<Frame> completionHandler, WriterInfo writerInfo, Boolean useTimeout)

send	back to summary
public Future<Frame> send(byte[] data) Deprecated Annotations @Deprecated

send	back to summary
public Future<Frame> send(byte[] data, WriterInfo writerInfo)

send	back to summary
public void send(final byte[] data, final SendHandler handler) Deprecated Annotations @Deprecated

send	back to summary
public void send(final byte[] data, final SendHandler handler, WriterInfo writerInfo)

send	back to summary
public Future<Frame> send(String data) Deprecated Annotations @Deprecated

send	back to summary
public Future<Frame> send(String data, WriterInfo writerInfo)

send	back to summary
public void send(final String data, final SendHandler handler) Deprecated Annotations @Deprecated

send	back to summary
public void send(final String data, final SendHandler handler, WriterInfo writerInfo)

sendRawFrame

back to summary

public Future<Frame> sendRawFrame(ByteBuffer data)

Raw frame is always whole (not partial).

Parameters

data:ByteBuffer: serialized frame.

Returns:Future<Frame>

send future.

setExtensionContext

back to summary

public void setExtensionContext(ExtendedExtension.ExtensionContext extensionContext)

Client side. Set extension context.

Parameters

extensionContext:ExtendedExtension.ExtensionContext: extension context.

setExtensions back to summary

public void setExtensions(List<Extension> extensions)

Client side. Set extensions negotiated for this WebSocket session/connection.

Parameters

extensions:List<Extension>: list of negotiated extensions. Can be null.

setMessageEventListener

back to summary

public void setMessageEventListener(MessageEventListener messageEventListener)

Set message event listener.

Parameters

messageEventListener:MessageEventListener: message event listener.

setWebSocket

back to summary

public void setWebSocket(TyrusWebSocket webSocket)

Client side. Set WebSocket.

Parameters

webSocket:TyrusWebSocket: client WebSocket connection.

setWriter back to summary

public void setWriter(Writer writer)

Set Writer instance.

The set instance is used for "sending" all outgoing WebSocket frames.

Parameters

writer:Writer: Writer to be set.

stream	back to summary
public Future<Frame> stream(boolean last, byte[] bytes, int off, int len) Deprecated Annotations @Deprecated

stream	back to summary
public Future<Frame> stream(boolean last, byte[] bytes, int off, int len, WriterInfo writerInfo)

stream	back to summary
public Future<Frame> stream(boolean last, String fragment) Deprecated Annotations @Deprecated

stream	back to summary
public Future<Frame> stream(boolean last, String fragment, WriterInfo writerInfo)

unframe

back to summary

public Frame unframe(ByteBuffer buffer)

TODO!

Parameters

buffer:ByteBuffer: TODO.

Returns:Frame

TODO.

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

write	back to summary
private Future<Frame> write(final TyrusFrame frame, final CompletionHandler<Frame> completionHandler, WriterInfo data, boolean useTimeout)

write	back to summary
private Future<Frame> write(final ByteBuffer frame, final CompletionHandler<Frame> completionHandler, WriterInfo data, boolean useTimeout)

org.glassfish.tyrus.core back to summary

private Class ProtocolHandler.CompletionHandlerWrapper

Class Inheritance

extends CompletionHandler<ByteBuffer>

java.lang.Object
org.glassfish.tyrus.spi.CompletionHandler
org.glassfish.tyrus.core.ProtocolHandler.CompletionHandlerWrapper

Handler passed to the org.glassfish.tyrus.spi.Writer.

Field Summary

Modifier and Type	Field and Description
private final Frame	frame
private final CompletionHandler<Frame>	frameCompletionHandler
private final TyrusFuture<Frame>	future

Constructor Summary

Access	Constructor and Description
private	CompletionHandlerWrapper(CompletionHandler<Frame> frameCompletionHandler, TyrusFuture<Frame> future, Frame frame)

Method Summary

Modifier and Type	Method and Description
public void	cancelled() Overrides org.glassfish.tyrus.spi.CompletionHandler.cancelled. The operation was cancelled.
public void	completed(ByteBuffer the operation result. result) Overrides org.glassfish.tyrus.spi.CompletionHandler.completed. The operation was completed.
public void	failed(Throwable error, which occurred during operation execution. throwable) Overrides org.glassfish.tyrus.spi.CompletionHandler.failed. The operation was failed.
public void	updated(ByteBuffer the current result. result) Overrides org.glassfish.tyrus.spi.CompletionHandler.updated. The callback method may be called, when there is some progress in operation execution, but it is still not completed.

Field Detail

frame	back to summary
private final Frame frame

frameCompletionHandler	back to summary
private final CompletionHandler<Frame> frameCompletionHandler

future	back to summary
private final TyrusFuture<Frame> future

Constructor Detail

CompletionHandlerWrapper	back to summary
private CompletionHandlerWrapper(CompletionHandler<Frame> frameCompletionHandler, TyrusFuture<Frame> future, Frame frame)

Method Detail

cancelled

back to summary

public void cancelled()

Overrides org.glassfish.tyrus.spi.CompletionHandler.cancelled.

Doc from org.glassfish.tyrus.spi.CompletionHandler.cancelled.

The operation was cancelled.

Annotations

@Override

completed

back to summary

public void completed(ByteBuffer result)

Overrides org.glassfish.tyrus.spi.CompletionHandler.completed.

Doc from org.glassfish.tyrus.spi.CompletionHandler.completed.

The operation was completed.

Parameters

result:ByteBuffer: the operation result.

Annotations

@Override

failed

back to summary

public void failed(Throwable throwable)

Overrides org.glassfish.tyrus.spi.CompletionHandler.failed.

Doc from org.glassfish.tyrus.spi.CompletionHandler.failed.

The operation was failed.

Parameters

throwable:Throwable: error, which occurred during operation execution.

Annotations

@Override

updated

back to summary

public void updated(ByteBuffer result)

Overrides org.glassfish.tyrus.spi.CompletionHandler.updated.

Doc from org.glassfish.tyrus.spi.CompletionHandler.updated.

The callback method may be called, when there is some progress in operation execution, but it is still not completed.

Parameters

result:ByteBuffer: the current result.

Annotations

@Override

org.glassfish.tyrus.core back to summary

private Class ProtocolHandler.ParsingState

Class Inheritance

extends Object

java.lang.Object
org.glassfish.tyrus.core.ProtocolHandler.ParsingState

Field Summary

Modifier and Type	Field and Description
pack-priv volatile boolean	controlFrame
pack-priv volatile boolean	finalFragment
pack-priv volatile long	length
private volatile byte	lengthCode
pack-priv volatile boolean	masked
pack-priv volatile Masker	masker
pack-priv volatile byte	opcode
pack-priv final AtomicInteger	state

Constructor Summary

Access	Constructor and Description
private	ParsingState()

Method Summary

Modifier and Type	Method and Description
pack-priv void	recycle()

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

Field Detail

controlFrame	back to summary
pack-priv volatile boolean controlFrame

finalFragment	back to summary
pack-priv volatile boolean finalFragment

length	back to summary
pack-priv volatile long length

lengthCode	back to summary
private volatile byte lengthCode

masked	back to summary
pack-priv volatile boolean masked

masker	back to summary
pack-priv volatile Masker masker

opcode	back to summary
pack-priv volatile byte opcode

state	back to summary
pack-priv final AtomicInteger state

Constructor Detail

ParsingState	back to summary
private ParsingState()

Method Detail

recycle	back to summary
pack-priv void recycle()

org.glassfish.tyrus.core back to summary

private final Enum ProtocolHandler.SendingFragmentState

Class Inheritance

extends Enum<ProtocolHandler.SendingFragmentState>

java.lang.Object
java.lang.Enum
org.glassfish.tyrus.core.ProtocolHandler.SendingFragmentState

Sending state.

Field Summary

Modifier and Type	Field and Description
public static final ProtocolHandler.SendingFragmentState	IDLE Session is idle - no partial message in progress.
public static final ProtocolHandler.SendingFragmentState	SENDING_BINARY Sending partial binary message - final frame was not yet sent.
public static final ProtocolHandler.SendingFragmentState	SENDING_TEXT Sending partial text message - final frame was not yet sent.

Constructor Summary

Access	Constructor and Description
private	SendingFragmentState()

Method Summary

Modifier and Type	Method and Description
public static ProtocolHandler.SendingFragmentState	valueOf(String name)
public static ProtocolHandler.SendingFragmentState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

IDLE	back to summary
public static final ProtocolHandler.SendingFragmentState IDLE Session is idle - no partial message in progress.

SENDING_BINARY	back to summary
public static final ProtocolHandler.SendingFragmentState SENDING_BINARY Sending partial binary message - final frame was not yet sent.

SENDING_TEXT	back to summary
public static final ProtocolHandler.SendingFragmentState SENDING_TEXT Sending partial text message - final frame was not yet sent.

Constructor Detail

SendingFragmentState	back to summary
private SendingFragmentState()

Method Detail

valueOf	back to summary
public static ProtocolHandler.SendingFragmentState valueOf(String name)

values	back to summary
public static ProtocolHandler.SendingFragmentState[] values()

public final Class ProtocolHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ProtocolHandler.CompletionHandlerWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ProtocolHandler.ParsingState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum ProtocolHandler.SendingFragmentState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail