io.vertx.core.http.impl

Class WebSocketImplBase

java.lang.Object

io.vertx.core.http.impl.WebSocketImplBase

All Implemented Interfaces:

WebSocketBase, ReadStream<Buffer>, StreamBase, WriteStream<Buffer>

Direct Known Subclasses:

ServerWebSocketImpl, WebSocketImpl

public abstract class WebSocketImplBase
extends Object
implements WebSocketBase

This class is optimised for performance when used on the same event loop. However it can be used safely from other threads. The internal state is protected using the synchronized keyword. If always used on the same event loop, then we benefit from biased locking which makes the overhead of synchronized near zero.

Author:

Tim Fox

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed
protected Handler<Void>	closeHandler
protected ConnectionBase	conn
protected Handler<Buffer>	dataHandler
protected Handler<Void>	drainHandler
protected Handler<Void>	endHandler
protected Handler<Throwable>	exceptionHandler
protected Handler<WebSocketFrame>	frameHandler

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebSocketImplBase(VertxInternal vertx, ConnectionBase conn, boolean supportsContinuation, int maxWebSocketFrameSize)

Method Summary

Modifier and Type	Method and Description
String	binaryHandlerID() When a Websocket is created it automatically registers an event handler with the event bus - the ID of that handler is given by this method.
protected void	checkClosed()
void	close() Close the WebSocket.
abstract WebSocketBase	exceptionHandler(Handler<Throwable> handler) Set an exception handler on the read stream.
SocketAddress	localAddress()
SocketAddress	remoteAddress()
String	textHandlerID() When a Websocket is created it automatically registers an event handler with the eventbus, the ID of that handler is given by textHandlerID.
protected void	writeBinaryFrameInternal(Buffer data)
protected void	writeFrameInternal(WebSocketFrame frame)
protected void	writeMessageInternal(Buffer data)
protected void	writePartialMessage(Buffer data, int offset)
boolean	writeQueueFull() This will return true if there are more bytes in the write queue than the value set using WriteStream.setWriteQueueMaxSize(int)
protected void	writeTextFrameInternal(String str)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.core.http.WebSocketBase

closeHandler, drainHandler, endHandler, frameHandler, handler, pause, resume, setWriteQueueMaxSize, write, writeBinaryMessage, writeFinalBinaryFrame, writeFinalTextFrame, writeFrame

Field Detail

conn

protected final ConnectionBase conn

frameHandler

protected Handler<WebSocketFrame> frameHandler

dataHandler

protected Handler<Buffer> dataHandler

drainHandler

protected Handler<Void> drainHandler

exceptionHandler

protected Handler<Throwable> exceptionHandler

closeHandler

protected Handler<Void> closeHandler

endHandler

protected Handler<Void> endHandler

closed

protected boolean closed

Constructor Detail

WebSocketImplBase

protected WebSocketImplBase(VertxInternal vertx,
                            ConnectionBase conn,
                            boolean supportsContinuation,
                            int maxWebSocketFrameSize)

Method Detail

binaryHandlerID

public String binaryHandlerID()

Description copied from interface: WebSocketBase

When a Websocket is created it automatically registers an event handler with the event bus - the ID of that handler is given by this method.

Given this ID, a different event loop can send a binary frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.

Specified by:

binaryHandlerID in interface WebSocketBase

Returns:

the binary handler id

textHandlerID

public String textHandlerID()

Description copied from interface: WebSocketBase

When a Websocket is created it automatically registers an event handler with the eventbus, the ID of that handler is given by textHandlerID.

Given this ID, a different event loop can send a text frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.

Specified by:

textHandlerID in interface WebSocketBase

writeQueueFull

public boolean writeQueueFull()

Description copied from interface: WriteStream

This will return true if there are more bytes in the write queue than the value set using WriteStream.setWriteQueueMaxSize(int)

Specified by:

writeQueueFull in interface WriteStream<Buffer>

Returns:

true if write queue is full

close

public void close()

Description copied from interface: WebSocketBase

Close the WebSocket.

Specified by:

close in interface WebSocketBase

localAddress

public SocketAddress localAddress()

Specified by:

localAddress in interface WebSocketBase

Returns:

the local address for this socket

remoteAddress

public SocketAddress remoteAddress()

Specified by:

remoteAddress in interface WebSocketBase

Returns:

the remote address for this socket

exceptionHandler

public abstract WebSocketBase exceptionHandler(Handler<Throwable> handler)

Description copied from interface: ReadStream

Set an exception handler on the read stream.

Specified by:

exceptionHandler in interface WebSocketBase

Specified by:

exceptionHandler in interface ReadStream<Buffer>

Specified by:

exceptionHandler in interface StreamBase

Specified by:

exceptionHandler in interface WriteStream<Buffer>

Parameters:

handler - the exception handler

Returns:

a reference to this, so the API can be used fluently

writeMessageInternal

protected void writeMessageInternal(Buffer data)

writePartialMessage

protected void writePartialMessage(Buffer data,
                                   int offset)

writeBinaryFrameInternal

protected void writeBinaryFrameInternal(Buffer data)

writeTextFrameInternal

protected void writeTextFrameInternal(String str)

writeFrameInternal

protected void writeFrameInternal(WebSocketFrame frame)

checkClosed

protected void checkClosed()