org.eclipse.jetty.websocket.api

Interface RemoteEndpoint

public interface RemoteEndpoint

Method Summary

Methods

Modifier and Type	Method and Description
void	sendBytes(ByteBuffer data) Send a binary message, returning when all bytes of the message has been transmitted.
Future<Void>	sendBytesByFuture(ByteBuffer data) Initiates the asynchronous transmission of a binary message.
void	sendPartialBytes(ByteBuffer fragment, 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 text) Send a text message, blocking until all bytes of the message has been transmitted.
Future<Void>	sendStringByFuture(String text) Initiates the asynchronous transmission of a text message.

Method Detail

sendBytes

void sendBytes(ByteBuffer data)
               throws IOException

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

Note: this is a blocking call

Parameters:

data - the message to be sent

Throws:

IOException

sendBytesByFuture

Future<Void> sendBytesByFuture(ByteBuffer data)

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 WriteResult object in either case.

Parameters:

data - the data being sent

completion - handler that will be notified of progress

Returns:

the Future object representing the send operation.

sendPartialBytes

void sendPartialBytes(ByteBuffer fragment,
                    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:

fragment - the piece of the message being sent

Throws:

IOException

sendPartialString

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

Throws:

IOException

sendPing

void sendPing(ByteBuffer applicationData)
              throws IOException

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

Throws:

IOException

sendPong

void sendPong(ByteBuffer applicationData)
              throws IOException

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.

Throws:

IOException

sendString

void sendString(String text)
                throws IOException

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

Note: this is a blocking call

Parameters:

text - the message to be sent

Throws:

IOException

sendStringByFuture

Future<Void> sendStringByFuture(String text)

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 WriteResult object in either case.

Parameters:

text - the text being sent

completion - the handler which will be notified of progress

Returns:

the Future object representing the send operation.