org.glassfish.tyrus.spi

Class SPIRemoteEndpoint

java.lang.Object

org.glassfish.tyrus.spi.SPIRemoteEndpoint

public abstract class SPIRemoteEndpoint
extends Object

Subset of RemoteEndpoint interface which should be implemented by container implementations.

Author:

Pavel Bucek (pavel.bucek at oracle.com)

Constructor Summary

Constructors

Constructor and Description
SPIRemoteEndpoint()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close(javax.websocket.CloseReason closeReason) Send a Close message.
abstract void	sendBytes(ByteBuffer data) Send a binary message, returning when all of the message has been transmitted.
abstract void	sendPartialBytes(ByteBuffer partialByte, boolean isLast) Send a binary message in pieces, blocking until all of the message has been transmitted.
abstract void	sendPartialString(String fragment, boolean isLast) Send a text message in pieces, blocking until all of the message has been transmitted.
abstract void	sendPing(ByteBuffer applicationData) Send a Ping message containing the given application data to the remote endpoint.
abstract void	sendPong(ByteBuffer applicationData) Allows the developer to send an unsolicited Pong message containing the given application data in order to serve as a unidirectional heartbeat for the session.
abstract void	sendString(String text) Send a text message, blocking until all of the message has been transmitted.

Methods inherited from class java.lang.Object

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

Constructor Detail

SPIRemoteEndpoint

public SPIRemoteEndpoint()

Method Detail

sendString

public abstract void sendString(String text)
                         throws IOException

Send a text message, blocking until all of the message has been transmitted.

Parameters:

text - the message to be sent.

Throws:

IOException

sendBytes

public abstract void sendBytes(ByteBuffer data)
                        throws IOException

Send a binary message, returning when all of the message has been transmitted.

Parameters:

data - the message to be sent.

Throws:

IOException

sendPartialString

public abstract void sendPartialString(String fragment,
                     boolean isLast)
                                throws IOException

Send a text message in pieces, blocking until all of the message has been transmitted. The runtime reads the message in order. Non-final pieces are sent with isLast set to false. The final piece must be sent with isLast set to true.

Parameters:

fragment - the piece of the message being sent.

isLast - Whether the fragment being sent is the last piece of the message.

Throws:

IOException

sendPartialBytes

public abstract void sendPartialBytes(ByteBuffer partialByte,
                    boolean isLast)
                               throws IOException

Send a binary message in pieces, blocking until all of the message has been transmitted. The runtime reads the message in order. Non-final pieces are sent with isLast set to false. The final piece must be sent with isLast set to true.

Parameters:

partialByte - the piece of the message being sent.

isLast - Whether the fragment being sent is the last piece of the message.

Throws:

IOException

sendPing

public abstract void sendPing(ByteBuffer applicationData)

Send a Ping message containing the given application data to the remote endpoint. The corresponding Pong message may be picked up using the MessageHandler.Pong handler.

Parameters:

applicationData - the data to be carried in the ping request.

sendPong

public abstract void sendPong(ByteBuffer applicationData)

Allows the developer to send an unsolicited Pong message containing the given application data in order to serve as a unidirectional heartbeat for the session.

Parameters:

applicationData - the application data to be carried in the pong response.

close

public abstract void close(javax.websocket.CloseReason closeReason)

Send a Close message.

Parameters:

closeReason - close reason.