Apache Tomcat 7.0.54

org.apache.tomcat.websocket
Class WsRemoteEndpointBase

java.lang.Object
  extended by org.apache.tomcat.websocket.WsRemoteEndpointBase
All Implemented Interfaces:
RemoteEndpoint
Direct Known Subclasses:
WsRemoteEndpointAsync, WsRemoteEndpointBasic

public abstract class WsRemoteEndpointBase
extends Object
implements RemoteEndpoint


Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.websocket.RemoteEndpoint
RemoteEndpoint.Async, RemoteEndpoint.Basic
 
Field Summary
protected  WsRemoteEndpointImplBase base
           
 
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(ByteBuffer applicationData)
          Send a ping message blocking until the message has been sent.
 void sendPong(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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

base

protected final WsRemoteEndpointImplBase base
Method Detail

setBatchingAllowed

public final void setBatchingAllowed(boolean batchingAllowed)
                              throws IOException
Description copied from interface: javax.websocket.RemoteEndpoint
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.

Specified by:
setBatchingAllowed in interface RemoteEndpoint
Parameters:
batchingAllowed - New setting
Throws:
IOException - If changing the value resulted in a call to RemoteEndpoint.flushBatch() and that call threw an IOException.

getBatchingAllowed

public final boolean getBatchingAllowed()
Description copied from interface: javax.websocket.RemoteEndpoint
Obtains the current batching status of the endpoint.

Specified by:
getBatchingAllowed in interface RemoteEndpoint

flushBatch

public final void flushBatch()
                      throws IOException
Description copied from interface: javax.websocket.RemoteEndpoint
Flush any currently batched messages to the remote endpoint. This method will block until the flush completes.

Specified by:
flushBatch in interface RemoteEndpoint
Throws:
IOException

sendPing

public final void sendPing(ByteBuffer applicationData)
                    throws IOException,
                           IllegalArgumentException
Description copied from interface: javax.websocket.RemoteEndpoint
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.

Specified by:
sendPing in interface RemoteEndpoint
Parameters:
applicationData - The payload for the ping message
Throws:
IOException
IllegalArgumentException

sendPong

public final void sendPong(ByteBuffer applicationData)
                    throws IOException,
                           IllegalArgumentException
Description copied from interface: javax.websocket.RemoteEndpoint
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.

Specified by:
sendPong in interface RemoteEndpoint
Parameters:
applicationData - The payload for the pong message
Throws:
IOException
IllegalArgumentException

Apache Tomcat 7.0.54

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