Tyrus 2.2.0 · org.glassfish.tyrus.core.TyrusWebSocket

Modifier and Type	Class and Description
private static enum	TyrusWebSocket.State

Modifier and Type	Field and Description
private final EnumSet<TyrusWebSocket.State>	connected
private final TyrusEndpointWrapper	endpointWrapper
private final Lock	lock
private volatile MessageEventListener	messageEventListener
private final CountDownLatch	onConnectLatch
private static final WriterInfo	PING_INFO
private static final WriterInfo	PONG_INFO
private final ProtocolHandler	protocolHandler
private final AtomicReference<TyrusWebSocket.State>	state

Access	Constructor and Description
public	TyrusWebSocket(final ProtocolHandler used for writing data (sending). protocolHandler, final TyrusEndpointWrapper notifies registered endpoints about incoming events. endpointWrapper) Create new instance, set `ProtocolHandler` and register `TyrusEndpointWrapper`.

Method Summary

Modifier and Type	Method and Description
private void	awaitOnConnect()
private void	checkConnectedState()
public void	close() Closes this `TyrusWebSocket`.
public void	close(int the closing status code. code, String the reason, if any. reason) Closes this `TyrusWebSocket` using the specified status code and reason.
public void	close(CloseReason the close reason. closeReason) Closes this `TyrusWebSocket` using the `jakarta.websocket.CloseReason`.
pack-priv MessageEventListener	Returns: message event listener. getMessageEventListener() Get message event listener.
pack-priv ProtocolHandler	getProtocolHandler()
public boolean	Returns: `true` if the `TyrusWebSocket` is connected, `false` otherwise. isConnected() Convenience method to determine if this `TyrusWebSocket` instance is connected.
public void	onClose(CloseFrame the close frame from the remote endpoint. frame) This callback will be invoked when the remote endpoint sent a closing frame.
public void	onConnect(UpgradeRequest request associated with this socket. upgradeRequest, String negotiated subprotocol. subProtocol, List<Extension> negotiated extensions. extensions, String connection id. connectionId, DebugContext debug context. debugContext) This callback will be invoked when the opening handshake between both endpoints has been completed.
public void	onFragment(BinaryFrame the binary data received from the remote endpoint. frame, boolean flag indicating whether or not the payload received is the final fragment of a message. last) This callback will be invoked when a fragmented binary message has been received.
public void	onFragment(TextFrame the text received from the remote endpoint. frame, boolean flag indicating whether or not the payload received is the final fragment of a message. last) This callback will be invoked when a fragmented textual message has been received.
public void	onMessage(BinaryFrame the binary data received from the remote endpoint. frame) This callback will be invoked when a binary message has been received.
public void	onMessage(TextFrame the text received from the remote endpoint. frame) This callback will be invoked when a text message has been received.
public void	onPing(PingFrame the ping frame from the remote endpoint. frame) This callback will be invoked when the remote endpoint has sent a ping frame.
public void	onPong(PongFrame the pong frame from the remote endpoint. frame) This callback will be invoked when the remote endpoint has sent a pong frame.
private Future<Frame>	send(TyrusFrame frame, WriterInfo writerInfo)
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendBinary(byte[] data to be sent. data) Deprecated Send a binary frame to the remote endpoint.
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendBinary(byte[] data to be sent. data, WriterInfo information about the outbound message. writerInfo) Send a binary frame to the remote endpoint.
public void	sendBinary(byte[] data to be sent. data, SendHandler `SendHandler#onResult(jakarta.websocket.SendResult)` will be called when sending is complete. handler) Deprecated Send a binary frame to the remote endpoint.
public void	sendBinary(byte[] data to be sent. data, SendHandler `SendHandler#onResult(jakarta.websocket.SendResult)` will be called when sending is complete. handler, WriterInfo information about the outbound message. writerInfo) Send a binary frame to the remote endpoint.
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendBinary(byte[] the binary fragment to send. bytes, boolean boolean indicating if this message fragment is the last. last) Deprecated Sends a fragment of a complete message.
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendBinary(byte[] the binary fragment to send. bytes, boolean boolean indicating if this message fragment is the last. last, WriterInfo information about the outbound message. writerInfo) Sends a fragment of a complete message.
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendBinary(byte[] the binary fragment to send. bytes, int the offset within the fragment to send. off, int the number of bytes of the fragment to send. len, boolean boolean indicating if this message fragment is the last. last) Deprecated Sends a fragment of a complete message.
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendBinary(byte[] the binary fragment to send. bytes, int the offset within the fragment to send. off, int the number of bytes of the fragment to send. len, boolean boolean indicating if this message fragment is the last. last, WriterInfo information about the outbound message. writerInfo) Sends a fragment of a complete message.
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendPing(byte[] optional payload. Note that payload length is restricted to 125 bytes or less. data) Sends a `ping` frame with the specified payload (if any).
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendPong(byte[] optional payload. Note that payload length is restricted to 125 bytes or less. data) Sends a `ping` frame with the specified payload (if any).
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendRawFrame(ByteBuffer complete data frame. data) Send a frame to the remote endpoint.
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendText(String data to be sent. data) Deprecated Send a text frame to the remote endpoint.
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendText(String data to be sent. data, WriterInfo information about the outbound message. writerInfo) Send a text frame to the remote endpoint.
public void	sendText(String data to be sent. data, SendHandler `SendHandler#onResult(jakarta.websocket.SendResult)` will be called when sending is complete. handler) Deprecated Send a text frame to the remote endpoint.
public void	sendText(String data to be sent. data, SendHandler `SendHandler#onResult(jakarta.websocket.SendResult)` will be called when sending is complete. handler, WriterInfo information about the outbound message. writerInfo) Send a text frame to the remote endpoint.
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendText(String the textual fragment to send. fragment, boolean boolean indicating if this message fragment is the last. last) Deprecated Sends a fragment of a complete message.
public Future<Frame>	Returns: `Future` which could be used to control/check the sending completion state. sendText(String the textual fragment to send. fragment, boolean boolean indicating if this message fragment is the last. last, WriterInfo information about the outbound message. writerInfo) Sends a fragment of a complete message.
pack-priv void	setMessageEventListener(MessageEventListener message event listener. messageEventListener) Set message event listener.
public void	setWriteTimeout(long timeout in milliseconds. timeoutMs) Sets the timeout for the writing operation.

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

connected	back to summary
private final EnumSet<TyrusWebSocket.State> connected

endpointWrapper	back to summary
private final TyrusEndpointWrapper endpointWrapper

lock	back to summary
private final Lock lock

messageEventListener	back to summary
private volatile MessageEventListener messageEventListener

onConnectLatch	back to summary
private final CountDownLatch onConnectLatch

PING_INFO	back to summary
private static final WriterInfo PING_INFO

PONG_INFO	back to summary
private static final WriterInfo PONG_INFO

protocolHandler	back to summary
private final ProtocolHandler protocolHandler

state	back to summary
private final AtomicReference<TyrusWebSocket.State> state

TyrusWebSocket	back to summary
public TyrusWebSocket(final ProtocolHandler protocolHandler, final TyrusEndpointWrapper endpointWrapper) Create new instance, set `ProtocolHandler` and register `TyrusEndpointWrapper`. Parameters protocolHandler:ProtocolHandler used for writing data (sending). endpointWrapper:TyrusEndpointWrapper notifies registered endpoints about incoming events.

Method Detail

awaitOnConnect	back to summary
private void awaitOnConnect()

checkConnectedState	back to summary
private void checkConnectedState()

close	back to summary
public void close() Closes this `TyrusWebSocket`.

close back to summary

close	back to summary
public void close(int code, String reason) Closes this `TyrusWebSocket` using the specified status code and reason. Parameters code:int the closing status code. reason:String the reason, if any.

public void close(int code, String reason)

Closes this TyrusWebSocket using the specified status code and reason.

Parameters

code:int: the closing status code.
reason:String: the reason, if any.

close back to summary

close	back to summary
public void close(CloseReason closeReason) Closes this `TyrusWebSocket` using the `jakarta.websocket.CloseReason`. Parameters closeReason:CloseReason the close reason.

public void close(CloseReason closeReason)

Closes this TyrusWebSocket using the jakarta.websocket.CloseReason.

Parameters

closeReason:CloseReason: the close reason.

getMessageEventListener	back to summary
pack-priv MessageEventListener getMessageEventListener() Get message event listener. Returns:MessageEventListener message event listener.

getMessageEventListener

back to summary

pack-priv MessageEventListener getMessageEventListener()

Get message event listener.

Returns:MessageEventListener: message event listener.

getProtocolHandler	back to summary
pack-priv ProtocolHandler getProtocolHandler()

isConnected back to summary

isConnected	back to summary
public boolean isConnected() Convenience method to determine if this `TyrusWebSocket` instance is connected. Returns:boolean `true` if the `TyrusWebSocket` is connected, `false` otherwise.

public boolean isConnected()

Convenience method to determine if this TyrusWebSocket instance is connected.

Returns:boolean: true if the TyrusWebSocket is connected, false otherwise.

onClose back to summary

onClose	back to summary
public void onClose(CloseFrame frame) This callback will be invoked when the remote endpoint sent a closing frame. The execution of this method is synchronized using `ProtocolHandler` instance; see TYRUS-385. Prevents multiple invocations, especially from container/user code. Parameters frame:CloseFrame the close frame from the remote endpoint.

public void onClose(CloseFrame frame)

This callback will be invoked when the remote endpoint sent a closing frame.

The execution of this method is synchronized using ProtocolHandler instance; see TYRUS-385. Prevents multiple invocations, especially from container/user code.

Parameters

frame:CloseFrame: the close frame from the remote endpoint.

onConnect	back to summary
public void onConnect(UpgradeRequest upgradeRequest, String subProtocol, List<Extension> extensions, String connectionId, DebugContext debugContext) This callback will be invoked when the opening handshake between both endpoints has been completed. Parameters upgradeRequest:UpgradeRequest request associated with this socket. subProtocol:String negotiated subprotocol. extensions:List<Extension> negotiated extensions. connectionId:String connection id. debugContext:DebugContext debug context.

onConnect

back to summary

public void onConnect(UpgradeRequest upgradeRequest, String subProtocol, List<Extension> extensions, String connectionId, DebugContext debugContext)

This callback will be invoked when the opening handshake between both endpoints has been completed.

Parameters

upgradeRequest:UpgradeRequest: request associated with this socket.
subProtocol:String: negotiated subprotocol.
extensions:List<Extension>: negotiated extensions.
connectionId:String: connection id.
debugContext:DebugContext: debug context.

onFragment	back to summary
public void onFragment(BinaryFrame frame, boolean last) This callback will be invoked when a fragmented binary message has been received. Parameters frame:BinaryFrame the binary data received from the remote endpoint. last:boolean flag indicating whether or not the payload received is the final fragment of a message.

onFragment

back to summary

public void onFragment(BinaryFrame frame, boolean last)

This callback will be invoked when a fragmented binary message has been received.

Parameters

frame:BinaryFrame: the binary data received from the remote endpoint.
last:boolean: flag indicating whether or not the payload received is the final fragment of a message.

onFragment	back to summary
public void onFragment(TextFrame frame, boolean last) This callback will be invoked when a fragmented textual message has been received. Parameters frame:TextFrame the text received from the remote endpoint. last:boolean flag indicating whether or not the payload received is the final fragment of a message.

onFragment

back to summary

public void onFragment(TextFrame frame, boolean last)

This callback will be invoked when a fragmented textual message has been received.

Parameters

frame:TextFrame: the text received from the remote endpoint.
last:boolean: flag indicating whether or not the payload received is the final fragment of a message.

onMessage	back to summary
public void onMessage(BinaryFrame frame) This callback will be invoked when a binary message has been received. Parameters frame:BinaryFrame the binary data received from the remote endpoint.

onMessage

back to summary

public void onMessage(BinaryFrame frame)

This callback will be invoked when a binary message has been received.

Parameters

frame:BinaryFrame: the binary data received from the remote endpoint.

onMessage	back to summary
public void onMessage(TextFrame frame) This callback will be invoked when a text message has been received. Parameters frame:TextFrame the text received from the remote endpoint.

onMessage

back to summary

public void onMessage(TextFrame frame)

This callback will be invoked when a text message has been received.

Parameters

frame:TextFrame: the text received from the remote endpoint.

onPing	back to summary
public void onPing(PingFrame frame) This callback will be invoked when the remote endpoint has sent a ping frame. Parameters frame:PingFrame the ping frame from the remote endpoint.

onPing

back to summary

public void onPing(PingFrame frame)

This callback will be invoked when the remote endpoint has sent a ping frame.

Parameters

frame:PingFrame: the ping frame from the remote endpoint.

onPong	back to summary
public void onPong(PongFrame frame) This callback will be invoked when the remote endpoint has sent a pong frame. Parameters frame:PongFrame the pong frame from the remote endpoint.

onPong

back to summary

public void onPong(PongFrame frame)

This callback will be invoked when the remote endpoint has sent a pong frame.

Parameters

frame:PongFrame: the pong frame from the remote endpoint.

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

sendBinary back to summary

sendBinary	back to summary
public Future<Frame> sendBinary(byte[] data) Deprecated Send a binary frame to the remote endpoint. Parameters data:byte[] data to be sent. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state. Annotations @Deprecated

public Future<Frame> sendBinary(byte[] data)

Deprecated

Send a binary frame to the remote endpoint.

Parameters

data:byte[]: data to be sent.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

Annotations

@Deprecated

sendBinary back to summary

sendBinary	back to summary
public Future<Frame> sendBinary(byte[] data, WriterInfo writerInfo) Send a binary frame to the remote endpoint. Parameters data:byte[] data to be sent. writerInfo:WriterInfo information about the outbound message. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state.

public Future<Frame> sendBinary(byte[] data, WriterInfo writerInfo)

Send a binary frame to the remote endpoint.

Parameters

data:byte[]: data to be sent.
writerInfo:WriterInfo: information about the outbound message.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

sendBinary back to summary

sendBinary	back to summary
public void sendBinary(byte[] data, SendHandler handler) Deprecated Send a binary frame to the remote endpoint. Parameters data:byte[] data to be sent. handler:SendHandler `SendHandler#onResult(jakarta.websocket.SendResult)` will be called when sending is complete. Annotations @Deprecated

public void sendBinary(byte[] data, SendHandler handler)

Deprecated

Send a binary frame to the remote endpoint.

Parameters

data:byte[]: data to be sent.
handler:SendHandler: SendHandler#onResult(jakarta.websocket.SendResult) will be called when sending is complete.

Annotations

@Deprecated

sendBinary back to summary

sendBinary	back to summary
public void sendBinary(byte[] data, SendHandler handler, WriterInfo writerInfo) Send a binary frame to the remote endpoint. Parameters data:byte[] data to be sent. handler:SendHandler `SendHandler#onResult(jakarta.websocket.SendResult)` will be called when sending is complete. writerInfo:WriterInfo information about the outbound message.

public void sendBinary(byte[] data, SendHandler handler, WriterInfo writerInfo)

Send a binary frame to the remote endpoint.

Parameters

data:byte[]: data to be sent.
handler:SendHandler: SendHandler#onResult(jakarta.websocket.SendResult) will be called when sending is complete.
writerInfo:WriterInfo: information about the outbound message.

sendBinary back to summary

sendBinary	back to summary
public Future<Frame> sendBinary(byte[] bytes, boolean last) Deprecated Sends a fragment of a complete message. Parameters bytes:byte[] the binary fragment to send. last:boolean boolean indicating if this message fragment is the last. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state. Annotations @Deprecated

public Future<Frame> sendBinary(byte[] bytes, boolean last)

Deprecated

Sends a fragment of a complete message.

Parameters

bytes:byte[]: the binary fragment to send.
last:boolean: boolean indicating if this message fragment is the last.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

Annotations

@Deprecated

sendBinary back to summary

sendBinary	back to summary
public Future<Frame> sendBinary(byte[] bytes, boolean last, WriterInfo writerInfo) Sends a fragment of a complete message. Parameters bytes:byte[] the binary fragment to send. last:boolean boolean indicating if this message fragment is the last. writerInfo:WriterInfo information about the outbound message. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state.

public Future<Frame> sendBinary(byte[] bytes, boolean last, WriterInfo writerInfo)

Sends a fragment of a complete message.

Parameters

bytes:byte[]: the binary fragment to send.
last:boolean: boolean indicating if this message fragment is the last.
writerInfo:WriterInfo: information about the outbound message.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

sendBinary back to summary

sendBinary	back to summary
public Future<Frame> sendBinary(byte[] bytes, int off, int len, boolean last) Deprecated Sends a fragment of a complete message. Parameters bytes:byte[] the binary fragment to send. off:int the offset within the fragment to send. len:int the number of bytes of the fragment to send. last:boolean boolean indicating if this message fragment is the last. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state. Annotations @Deprecated

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

Deprecated

Sends a fragment of a complete message.

Parameters

bytes:byte[]: the binary fragment to send.
off:int: the offset within the fragment to send.
len:int: the number of bytes of the fragment to send.
last:boolean: boolean indicating if this message fragment is the last.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

Annotations

@Deprecated

sendBinary back to summary

sendBinary	back to summary
public Future<Frame> sendBinary(byte[] bytes, int off, int len, boolean last, WriterInfo writerInfo) Sends a fragment of a complete message. Parameters bytes:byte[] the binary fragment to send. off:int the offset within the fragment to send. len:int the number of bytes of the fragment to send. last:boolean boolean indicating if this message fragment is the last. writerInfo:WriterInfo information about the outbound message. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state.

public Future<Frame> sendBinary(byte[] bytes, int off, int len, boolean last, WriterInfo writerInfo)

Sends a fragment of a complete message.

Parameters

bytes:byte[]: the binary fragment to send.
off:int: the offset within the fragment to send.
len:int: the number of bytes of the fragment to send.
last:boolean: boolean indicating if this message fragment is the last.
writerInfo:WriterInfo: information about the outbound message.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

sendPing back to summary

sendPing	back to summary
public Future<Frame> sendPing(byte[] data) Sends a `ping` frame with the specified payload (if any). Parameters data:byte[] optional payload. Note that payload length is restricted to 125 bytes or less. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state.

public Future<Frame> sendPing(byte[] data)

Sends a ping frame with the specified payload (if any).

Parameters

data:byte[]: optional payload. Note that payload length is restricted to 125 bytes or less.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

sendPong back to summary

sendPong	back to summary
public Future<Frame> sendPong(byte[] data) Sends a `ping` frame with the specified payload (if any). It may seem odd to send a pong frame, however, RFC-6455 states: "A Pong frame MAY be sent unsolicited. This serves as a unidirectional heartbeat. A response to an unsolicited Pong frame is not expected." Parameters data:byte[] optional payload. Note that payload length is restricted to 125 bytes or less. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state.

public Future<Frame> sendPong(byte[] data)

Sends a ping frame with the specified payload (if any).

It may seem odd to send a pong frame, however, RFC-6455 states: "A Pong frame MAY be sent unsolicited. This serves as a unidirectional heartbeat. A response to an unsolicited Pong frame is not expected."

Parameters

data:byte[]: optional payload. Note that payload length is restricted to 125 bytes or less.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

sendRawFrame back to summary

sendRawFrame	back to summary
public Future<Frame> sendRawFrame(ByteBuffer data) Send a frame to the remote endpoint. Parameters data:ByteBuffer complete data frame. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state.

public Future<Frame> sendRawFrame(ByteBuffer data)

Send a frame to the remote endpoint.

Parameters

data:ByteBuffer: complete data frame.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

sendText back to summary

sendText	back to summary
public Future<Frame> sendText(String data) Deprecated Send a text frame to the remote endpoint. Parameters data:String data to be sent. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state. Annotations @Deprecated

public Future<Frame> sendText(String data)

Deprecated

Send a text frame to the remote endpoint.

Parameters

data:String: data to be sent.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

Annotations

@Deprecated

sendText back to summary

sendText	back to summary
public Future<Frame> sendText(String data, WriterInfo writerInfo) Send a text frame to the remote endpoint. Parameters data:String data to be sent. writerInfo:WriterInfo information about the outbound message. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state.

public Future<Frame> sendText(String data, WriterInfo writerInfo)

Send a text frame to the remote endpoint.

Parameters

data:String: data to be sent.
writerInfo:WriterInfo: information about the outbound message.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

sendText back to summary

sendText	back to summary
public void sendText(String data, SendHandler handler) Deprecated Send a text frame to the remote endpoint. Parameters data:String data to be sent. handler:SendHandler `SendHandler#onResult(jakarta.websocket.SendResult)` will be called when sending is complete. Annotations @Deprecated

public void sendText(String data, SendHandler handler)

Deprecated

Send a text frame to the remote endpoint.

Parameters

data:String: data to be sent.
handler:SendHandler: SendHandler#onResult(jakarta.websocket.SendResult) will be called when sending is complete.

Annotations

@Deprecated

sendText back to summary

sendText	back to summary
public void sendText(String data, SendHandler handler, WriterInfo writerInfo) Send a text frame to the remote endpoint. Parameters data:String data to be sent. handler:SendHandler `SendHandler#onResult(jakarta.websocket.SendResult)` will be called when sending is complete. writerInfo:WriterInfo information about the outbound message.

public void sendText(String data, SendHandler handler, WriterInfo writerInfo)

Send a text frame to the remote endpoint.

Parameters

data:String: data to be sent.
handler:SendHandler: SendHandler#onResult(jakarta.websocket.SendResult) will be called when sending is complete.
writerInfo:WriterInfo: information about the outbound message.

sendText back to summary

sendText	back to summary
public Future<Frame> sendText(String fragment, boolean last) Deprecated Sends a fragment of a complete message. Parameters fragment:String the textual fragment to send. last:boolean boolean indicating if this message fragment is the last. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state. Annotations @Deprecated

public Future<Frame> sendText(String fragment, boolean last)

Deprecated

Sends a fragment of a complete message.

Parameters

fragment:String: the textual fragment to send.
last:boolean: boolean indicating if this message fragment is the last.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

Annotations

@Deprecated

sendText back to summary

sendText	back to summary
public Future<Frame> sendText(String fragment, boolean last, WriterInfo writerInfo) Sends a fragment of a complete message. Parameters fragment:String the textual fragment to send. last:boolean boolean indicating if this message fragment is the last. writerInfo:WriterInfo information about the outbound message. Returns:Future<Frame> `Future` which could be used to control/check the sending completion state.

public Future<Frame> sendText(String fragment, boolean last, WriterInfo writerInfo)

Sends a fragment of a complete message.

Parameters

fragment:String: the textual fragment to send.
last:boolean: boolean indicating if this message fragment is the last.
writerInfo:WriterInfo: information about the outbound message.

Returns:Future<Frame>

Future which could be used to control/check the sending completion state.

setMessageEventListener	back to summary
pack-priv void setMessageEventListener(MessageEventListener messageEventListener) Set message event listener. Parameters messageEventListener:MessageEventListener message event listener.

setMessageEventListener

back to summary

pack-priv void setMessageEventListener(MessageEventListener messageEventListener)

Set message event listener.

Parameters

messageEventListener:MessageEventListener: message event listener.

setWriteTimeout	back to summary
public void setWriteTimeout(long timeoutMs) Sets the timeout for the writing operation. Parameters timeoutMs:long timeout in milliseconds.

setWriteTimeout

back to summary

public void setWriteTimeout(long timeoutMs)

Sets the timeout for the writing operation.

Parameters

timeoutMs:long: timeout in milliseconds.

Modifier and Type	Field and Description
public static final TyrusWebSocket.State	CLOSED
public static final TyrusWebSocket.State	CLOSING
public static final TyrusWebSocket.State	CONNECTED
public static final TyrusWebSocket.State	NEW

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

public Class TyrusWebSocket

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum TyrusWebSocket.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail