Package javax.websocket
Interface RemoteEndpoint
- All Known Subinterfaces:
RemoteEndpoint.Async,RemoteEndpoint.Basic
public interface RemoteEndpoint
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfacestatic interface -
Method Summary
Modifier and TypeMethodDescriptionvoidFlush any currently batched messages to the remote endpoint.booleanObtains the current batching status of the endpoint.voidsendPing(ByteBuffer applicationData) Send a ping message blocking until the message has been sent.voidsendPong(ByteBuffer applicationData) Send a pong message blocking until the message has been sent.voidsetBatchingAllowed(boolean batchingAllowed) Enable or disable the batching of outgoing messages for this endpoint.
-
Method Details
-
setBatchingAllowed
Enable or disable the batching of outgoing messages for this endpoint. If batching is disabled when it was previously enabled then this method will block until any currently batched messages have been written.- Parameters:
batchingAllowed- New setting- Throws:
IOException- If changing the value resulted in a call toflushBatch()and that call threw anIOException.
-
getBatchingAllowed
boolean getBatchingAllowed()Obtains the current batching status of the endpoint.- Returns:
trueif batching is enabled, otherwisefalse.
-
flushBatch
Flush any currently batched messages to the remote endpoint. This method will block until the flush completes.- Throws:
IOException- If an I/O error occurs while flushing
-
sendPing
Send a ping message blocking until the message has been sent. Note that if a message is in the process of being sent asynchronously, this method will block until that message and this ping has been sent.- Parameters:
applicationData- The payload for the ping message- Throws:
IOException- If an I/O error occurs while sending the pingIllegalArgumentException- if the applicationData is too large for a control message (max 125 bytes)
-
sendPong
Send a pong message blocking until the message has been sent. Note that if a message is in the process of being sent asynchronously, this method will block until that message and this pong has been sent.- Parameters:
applicationData- The payload for the pong message- Throws:
IOException- If an I/O error occurs while sending the pongIllegalArgumentException- if the applicationData is too large for a control message (max 125 bytes)
-