WebSocket 1.0 - Apache Tomcat 7.0.47

javax.websocket
Interface RemoteEndpoint

All Known Subinterfaces:
RemoteEndpoint.Async, RemoteEndpoint.Basic

public interface RemoteEndpoint


Nested Class Summary
static interface RemoteEndpoint.Async
           
static interface RemoteEndpoint.Basic
           
 
Method Summary
 void flushBatch()
          Flush any currently batched messages to the remote endpoint.
 boolean getBatchingAllowed()
          Obtains the current batching status of the endpoint.
 void sendPing(java.nio.ByteBuffer applicationData)
          Send a ping message blocking until the message has been sent.
 void sendPong(java.nio.ByteBuffer applicationData)
          Send a pong message blocking until the message has been sent.
 void setBatchingAllowed(boolean batchingAllowed)
          Enable or disable the batching of outgoing messages for this endpoint.
 

Method Detail

setBatchingAllowed

void setBatchingAllowed(boolean batchingAllowed)
                        throws java.io.IOException
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:
java.io.IOException - If changing the value resulted in a call to flushBatch() and that call threw an IOException.

getBatchingAllowed

boolean getBatchingAllowed()
Obtains the current batching status of the endpoint.


flushBatch

void flushBatch()
                throws java.io.IOException
Flush any currently batched messages to the remote endpoint. This method will block until the flush completes.

Throws:
java.io.IOException

sendPing

void sendPing(java.nio.ByteBuffer applicationData)
              throws java.io.IOException,
                     java.lang.IllegalArgumentException
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:
java.io.IOException
java.lang.IllegalArgumentException

sendPong

void sendPong(java.nio.ByteBuffer applicationData)
              throws java.io.IOException,
                     java.lang.IllegalArgumentException
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:
java.io.IOException
java.lang.IllegalArgumentException

WebSocket 1.0 - Apache Tomcat 7.0.47

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.