Package org.eclipse.jetty.websocket.common

Class WebSocketRemoteEndpoint

java.lang.Object

org.eclipse.jetty.websocket.common.WebSocketRemoteEndpoint

All Implemented Interfaces:

RemoteEndpoint

public class WebSocketRemoteEndpoint
extends Object
implements RemoteEndpoint

Endpoint for Writing messages to the Remote websocket.

Constructor Summary

Constructors

Constructor	Description
WebSocketRemoteEndpoint(LogicalConnection connection, OutgoingFrames outgoing)
WebSocketRemoteEndpoint(LogicalConnection connection, OutgoingFrames outgoing, BatchMode batchMode)

Method Summary

Modifier and Type	Method	Description
void	flush()
BatchMode	getBatchMode()
InetSocketAddress	getInetSocketAddress()	Get the InetSocketAddress for the established connection.
int	getMaxOutgoingFrames()
void	sendBytes(ByteBuffer data)	Blocking write of bytes.
void	sendBytes(ByteBuffer data, WriteCallback callback)
Future<Void>	sendBytesByFuture(ByteBuffer data)
void	sendPartialBytes(ByteBuffer fragment, boolean isLast)
void	sendPartialString(String fragment, boolean isLast)
void	sendPing(ByteBuffer applicationData)
void	sendPong(ByteBuffer applicationData)
void	sendString(String text)
void	sendString(String text, WriteCallback callback)
Future<Void>	sendStringByFuture(String text)
void	setBatchMode(BatchMode batchMode)
void	setMaxOutgoingFrames(int maxOutgoingFrames)
String	toString()
void	uncheckedSendFrame(WebSocketFrame frame, WriteCallback callback)

Methods inherited from class java.lang.Object

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

Constructor Details

WebSocketRemoteEndpoint

public WebSocketRemoteEndpoint(LogicalConnection connection,
 OutgoingFrames outgoing)

WebSocketRemoteEndpoint

public WebSocketRemoteEndpoint(LogicalConnection connection,
 OutgoingFrames outgoing,
 BatchMode batchMode)

Method Details

getInetSocketAddress

public InetSocketAddress getInetSocketAddress()

Get the InetSocketAddress for the established connection.

Specified by:

getInetSocketAddress in interface RemoteEndpoint

Returns:

the InetSocketAddress for the established connection. (or null, if the connection is no longer established)

sendBytes

public void sendBytes(ByteBuffer data)
               throws IOException

Blocking write of bytes.

Specified by:

sendBytes in interface RemoteEndpoint

Throws:

IOException

sendBytesByFuture

public Future<Void> sendBytesByFuture(ByteBuffer data)

Specified by:

sendBytesByFuture in interface RemoteEndpoint

sendBytes

public void sendBytes(ByteBuffer data,
 WriteCallback callback)

Specified by:

sendBytes in interface RemoteEndpoint

uncheckedSendFrame

public void uncheckedSendFrame(WebSocketFrame frame,
 WriteCallback callback)

sendPartialBytes

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

Specified by:

sendPartialBytes in interface RemoteEndpoint

Throws:

IOException

sendPartialString

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

Specified by:

sendPartialString in interface RemoteEndpoint

Throws:

IOException

sendPing

public void sendPing(ByteBuffer applicationData)
              throws IOException

Specified by:

sendPing in interface RemoteEndpoint

Throws:

IOException

sendPong

public void sendPong(ByteBuffer applicationData)
              throws IOException

Specified by:

sendPong in interface RemoteEndpoint

Throws:

IOException

sendString

public void sendString(String text)
                throws IOException

Specified by:

sendString in interface RemoteEndpoint

Throws:

IOException

sendStringByFuture

public Future<Void> sendStringByFuture(String text)

Specified by:

sendStringByFuture in interface RemoteEndpoint

sendString

public void sendString(String text,
 WriteCallback callback)

Specified by:

sendString in interface RemoteEndpoint

getBatchMode

public BatchMode getBatchMode()

Specified by:

getBatchMode in interface RemoteEndpoint

setBatchMode

public void setBatchMode(BatchMode batchMode)

Specified by:

setBatchMode in interface RemoteEndpoint

getMaxOutgoingFrames

public int getMaxOutgoingFrames()

Specified by:

getMaxOutgoingFrames in interface RemoteEndpoint

setMaxOutgoingFrames

public void setMaxOutgoingFrames(int maxOutgoingFrames)

Specified by:

setMaxOutgoingFrames in interface RemoteEndpoint

flush

public void flush()
           throws IOException

Specified by:

flush in interface RemoteEndpoint

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object