org.glassfish.tyrus.platform

Class RemoteEndpointWrapper<T>

java.lang.Object

org.glassfish.tyrus.platform.RemoteEndpointWrapper<T>

All Implemented Interfaces:

RemoteEndpoint<T>

public final class RemoteEndpointWrapper<T>
extends Object
implements RemoteEndpoint<T>

Wrapps the RemoteEndpoint and represents the other side of the websocket connection.

Author:

Danny Coward, Martin Matula (martin.matula at oracle.com), Stepan Kopriva (stepan.kopriva at oracle.com)

Method Summary

Methods

Modifier and Type	Method and Description
void	close(CloseReason cr)
String	getAddress() URI to which the remote originally connected.
static RemoteEndpointWrapper	getRemoteWrapper(RemoteEndpoint socket, EndpointWrapper application) Get the RemoteEndpoint wrapper.
OutputStream	getSendStream() Opens an output stream on which a binary message may be sent.
Writer	getSendWriter() Opens an character stream on which a text message may be sent.
Session	getSession()
boolean	isConnected() The endpoint is connected.
void	sendBytes(ByteBuffer data) Send a binary message, returning when all of the message has been transmitted.
Future<SendResult>	sendBytes(ByteBuffer data, SendHandler completion) Initiates the asynchronous transmission of a binary message.
void	sendObject(T o) Sends a custom developer object, blocking until it has been transmitted.
Future<SendResult>	sendObject(T o, SendHandler handler) Initiates the transmission of a custom developer object.
void	sendPartialBytes(ByteBuffer byteBuffer, boolean isLast) Send a binary message in pieces, blocking until all of the message has been transmitted.
void	sendPartialString(String fragment, boolean isLast) Send a text message in pieces, blocking until all of the message has been transmitted.
void	sendPing(ByteBuffer applicationData) Send a Ping message containing the given application data to the remote endpoint.
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.
void	sendString(String data) Send a text message, blocking until all of the message has been transmitted.
Future<SendResult>	sendString(String text, SendHandler completion) Initiates the asynchronous transmission of a text message.
String	toString()
void	updateLastConnectionActivity()

Methods inherited from class java.lang.Object

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

Method Detail

getRemoteWrapper

public static RemoteEndpointWrapper getRemoteWrapper(RemoteEndpoint socket,
                                     EndpointWrapper application)

Get the RemoteEndpoint wrapper.

Parameters:

socket - socket corresponding to the required wrapper

application - web socket endpoint for which the wrapper represents the other side of the connection

Returns:

wrapper corresponding to socket

getAddress

public String getAddress()

URI to which the remote originally connected.

Returns:

URI

isConnected

public boolean isConnected()

The endpoint is connected.

Returns:

true iff the endpoint is connected, false otherwise.

sendString

public void sendString(String data)
                throws IOException

Description copied from interface: RemoteEndpoint

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

Specified by:

sendString in interface RemoteEndpoint<T>

Parameters:

data - the message to be sent.

Throws:

IOException

sendBytes

public void sendBytes(ByteBuffer data)
               throws IOException

Description copied from interface: RemoteEndpoint

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

Specified by:

sendBytes in interface RemoteEndpoint<T>

Parameters:

data - the message to be sent.

Throws:

IOException

sendPartialString

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

Description copied from interface: RemoteEndpoint

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.

Specified by:

sendPartialString in interface RemoteEndpoint<T>

Parameters:

fragment - the piece of the message being sent.

Throws:

IOException

sendPartialBytes

public void sendPartialBytes(ByteBuffer byteBuffer,
                    boolean isLast)
                      throws IOException

Description copied from interface: RemoteEndpoint

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.

Specified by:

sendPartialBytes in interface RemoteEndpoint<T>

Parameters:

byteBuffer - the piece of the message being sent.

Throws:

IOException

getSendStream

public OutputStream getSendStream()
                           throws IOException

Description copied from interface: RemoteEndpoint

Opens an output stream on which a binary message may be sent. The developer must close the output stream in order to indicate that the complete message has been placed into the output stream.

Specified by:

getSendStream in interface RemoteEndpoint<T>

Returns:

the output stream to which the message will be written.

Throws:

IOException

getSendWriter

public Writer getSendWriter()
                     throws IOException

Description copied from interface: RemoteEndpoint

Opens an character stream on which a text message may be sent. The developer must close the writer in order to indicate that the complete message has been placed into the character stream.

Specified by:

getSendWriter in interface RemoteEndpoint<T>

Returns:

the output stream to which the message will be written.

Throws:

IOException

sendObject

public void sendObject(T o)
                throws IOException,
                       EncodeException

Description copied from interface: RemoteEndpoint

Sends a custom developer object, blocking until it has been transmitted. Containers will by default be able to encode java primitive types, their object equivalents, and arrays or collections thereof. The developer will have provided an encoder for this object type in the endpoint configuration.

Specified by:

sendObject in interface RemoteEndpoint<T>

Parameters:

o - the object to be sent.

Throws:

IOException

EncodeException

sendString

public Future<SendResult> sendString(String text,
                            SendHandler completion)

Description copied from interface: RemoteEndpoint

Initiates the asynchronous transmission of a text message. This method returns before the message is transmitted. Developers may provide a callback to be notified when the message has been transmitted, or may use the returned Future object to track progress of the transmission. Errors in transmission are given to the developer in the SendResult object in either case.

Specified by:

sendString in interface RemoteEndpoint<T>

Parameters:

text - the text being sent.

completion - the handler which will be notified of progress.

Returns:

sendBytes

public Future<SendResult> sendBytes(ByteBuffer data,
                           SendHandler completion)

Description copied from interface: RemoteEndpoint

Initiates the asynchronous transmission of a binary message. This method returns before the message is transmitted. Developers may provide a callback to be notified when the message has been transmitted, or may use the returned Future object to track progress of the transmission. Errors in transmission are given to the developer in the SendResult object in either case.

Specified by:

sendBytes in interface RemoteEndpoint<T>

Parameters:

data - the data being sent.

completion - the handler that will be notified of progress.

Returns:

sendObject

public Future<SendResult> sendObject(T o,
                            SendHandler handler)

Description copied from interface: RemoteEndpoint

Initiates the transmission of a custom developer object. The developer will have provided an encoder for this object type in the endpoint configuration. Containers will by default be able to encode java primitive types, their object equivalents, and arrays or collections thereof. Progress can be tracked using the Future object, or the developer can wait for a provided callback object to be notified when transmission is complete.

Specified by:

sendObject in interface RemoteEndpoint<T>

Parameters:

o - the object being sent.

Returns:

sendPing

public void sendPing(ByteBuffer applicationData)

Description copied from interface: RemoteEndpoint

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.

Specified by:

sendPing in interface RemoteEndpoint<T>

Parameters:

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

sendPong

public void sendPong(ByteBuffer applicationData)

Description copied from interface: RemoteEndpoint

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.

Specified by:

sendPong in interface RemoteEndpoint<T>

Parameters:

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

toString

public String toString()

Overrides:

toString in class Object

close

public void close(CloseReason cr)
           throws IOException

Throws:

IOException

getSession

public Session getSession()

updateLastConnectionActivity

public void updateLastConnectionActivity()