WebSocketBase (Vert.x Core 3.6.2 API)

All Superinterfaces:

ReadStream<Buffer>, StreamBase, WriteStream<Buffer>

All Known Subinterfaces:

ServerWebSocket, WebSocket
```
public interface WebSocketBase
extends ReadStream<Buffer>, WriteStream<Buffer>
```
Base WebSocket implementation.
It implements both ReadStream and WriteStream so it can be used with Pump to pump data with flow control.

Author:

Tim Fox

Method Summary

All Methods Instance Methods Abstract Methods
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.
`WebSocketBase`	`binaryMessageHandler(Handler<Buffer> handler)` Set a binary message handler on the connection.
`void`	`close()` Close the WebSocket sending the default close frame.
`void`	`close(short statusCode)`
`void`	`close(short statusCode, String reason)`
`WebSocketBase`	`closeHandler(Handler<Void> handler)` Set a close handler.
`WebSocketBase`	`drainHandler(Handler<Void> handler)` Set a drain handler on the stream.
`void`	`end()` Calls `close()`
`WebSocketBase`	`endHandler(Handler<Void> endHandler)` Set an end handler.
`WebSocketBase`	`exceptionHandler(Handler<Throwable> handler)` Set an exception handler on the read stream.
`WebSocketBase`	`fetch(long amount)` Fetch the specified `amount` of elements.
`WebSocketBase`	`frameHandler(Handler<WebSocketFrame> handler)` Set a frame handler on the connection.
`WebSocketBase`	`handler(Handler<Buffer> handler)` Set a data handler.
`boolean`	`isSsl()`
`SocketAddress`	`localAddress()`
`WebSocketBase`	`pause()` Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
`X509Certificate[]`	`peerCertificateChain()` Note: Java SE 5+ recommends to use javax.net.ssl.SSLSession#getPeerCertificates() instead of of javax.net.ssl.SSLSession#getPeerCertificateChain() which this method is based on.
`WebSocketBase`	`pongHandler(Handler<Buffer> handler)` Set a pong message handler on the connection.
`SocketAddress`	`remoteAddress()`
`WebSocketBase`	`resume()` Resume reading, and sets the buffer in `flowing` mode.
`WebSocketBase`	`setWriteQueueMaxSize(int maxSize)` Set the maximum size of the write queue to `maxSize`.
`SSLSession`	`sslSession()`
`String`	`subProtocol()` Returns the websocket sub protocol selected by the websocket handshake.
`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`.
`WebSocketBase`	`textMessageHandler(Handler<String> handler)` Set a text message handler on the connection.
`WebSocketBase`	`write(Buffer data)` Write some data to the stream.
`WebSocketBase`	`writeBinaryMessage(Buffer data)` Writes a (potentially large) piece of binary data to the connection.
`WebSocketBase`	`writeFinalBinaryFrame(Buffer data)` Write a final WebSocket binary frame to the connection
`WebSocketBase`	`writeFinalTextFrame(String text)` Write a final WebSocket text frame to the connection
`WebSocketBase`	`writeFrame(WebSocketFrame frame)` Write a WebSocket frame to the connection
`WebSocketBase`	`writePing(Buffer data)` Writes a ping to the connection.
`WebSocketBase`	`writePong(Buffer data)` Writes a pong to the connection.
`WebSocketBase`	`writeTextMessage(String text)` Writes a (potentially large) piece of text data to the connection.

Methods inherited from interface io.vertx.core.streams.WriteStream
end, writeQueueFull

- Method Detail
  - exceptionHandler
```
WebSocketBase exceptionHandler(Handler<Throwable> handler)
```
    Description copied from interface: ReadStream
    
    Set an exception handler on the read stream.
    
    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
  - handler
```
WebSocketBase handler(Handler<Buffer> handler)
```
    Description copied from interface: ReadStream
    
    Set a data handler. As data is read, the handler will be called with the data.
    
    Specified by:
    
    handler in interface ReadStream<Buffer>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - pause
```
WebSocketBase pause()
```
    Description copied from interface: ReadStream
    
    Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.
    While it's paused, no data will be sent to the data handler.
    
    Specified by:
    
    pause in interface ReadStream<Buffer>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - resume
```
WebSocketBase resume()
```
    Description copied from interface: ReadStream
    
    Resume reading, and sets the buffer in flowing mode.
    If the ReadStream has been paused, reading will recommence on it.
    
    Specified by:
    
    resume in interface ReadStream<Buffer>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - fetch
```
WebSocketBase fetch(long amount)
```
    Description copied from interface: ReadStream
    
    Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.
    
    Specified by:
    
    fetch in interface ReadStream<Buffer>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - endHandler
```
WebSocketBase endHandler(Handler<Void> endHandler)
```
    Description copied from interface: ReadStream
    
    Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
    
    Specified by:
    
    endHandler in interface ReadStream<Buffer>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - write
```
WebSocketBase write(Buffer data)
```
    Description copied from interface: WriteStream
    
    Write some data to the stream. The data is put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the WriteStream.writeQueueFull() method before writing. This is done automatically if using a Pump.
    
    Specified by:
    
    write in interface WriteStream<Buffer>
    
    Parameters:
    
    data - the data to write
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setWriteQueueMaxSize
```
WebSocketBase setWriteQueueMaxSize(int maxSize)
```
    Description copied from interface: WriteStream
    
    Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even if there is more than maxSize items in the write queue. This is used as an indicator by classes such as Pump to provide flow control.
    The value is defined by the implementation of the stream, e.g in bytes for a NetSocket, the number of Message for a MessageProducer, etc...
    
    Specified by:
    
    setWriteQueueMaxSize in interface WriteStream<Buffer>
    
    Parameters:
    
    maxSize - the max size of the write stream
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - drainHandler
```
WebSocketBase drainHandler(Handler<Void> handler)
```
    Description copied from interface: WriteStream
    
    Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. See Pump for an example of this being used.
    The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to maxSize / 2.
    
    Specified by:
    
    drainHandler in interface WriteStream<Buffer>
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - binaryHandlerID
```
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.
    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.
    
    Returns:
    
    the binary handler id
  - textHandlerID
```
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.
    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.
  - subProtocol
```
String subProtocol()
```
    Returns the websocket sub protocol selected by the websocket handshake.
    On the server, the value will be null when the handler receives the websocket callback as the handshake will not be completed yet.
  - writeFrame
```
WebSocketBase writeFrame(WebSocketFrame frame)
```
    Write a WebSocket frame to the connection
    
    Parameters:
    
    frame - the frame to write
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - writeFinalTextFrame
```
WebSocketBase writeFinalTextFrame(String text)
```
    Write a final WebSocket text frame to the connection
    
    Parameters:
    
    text - The text to write
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - writeFinalBinaryFrame
```
WebSocketBase writeFinalBinaryFrame(Buffer data)
```
    Write a final WebSocket binary frame to the connection
    
    Parameters:
    
    data - The data to write
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - writeBinaryMessage
```
WebSocketBase writeBinaryMessage(Buffer data)
```
    Writes a (potentially large) piece of binary data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.
    
    Parameters:
    
    data - the data to write
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - writeTextMessage
```
WebSocketBase writeTextMessage(String text)
```
    Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.
    
    Parameters:
    
    text - the data to write
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - writePing
```
WebSocketBase writePing(Buffer data)
```
    Writes a ping to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).
    This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section 5.5.2.
    There is no pingHandler because RFC 6455 section 5.5.2 clearly states that the only response to a ping is a pong with identical contents.
    
    Parameters:
    
    data - the data to write, may be at most 125 bytes
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - writePong
```
WebSocketBase writePong(Buffer data)
```
    Writes a pong to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).
    This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section 5.5.2.
    There is no need to manually write a Pong, as the server and client both handle responding to a ping with a pong automatically and this is exposed to users.RFC 6455 Section 5.5.3 states that pongs may be sent unsolicited in order to implement a one way heartbeat.
    
    Parameters:
    
    data - the data to write, may be at most 125 bytes
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - closeHandler
```
WebSocketBase closeHandler(Handler<Void> handler)
```
    Set a close handler. This will be called when the WebSocket is closed.
    After this callback, no more messages are expected.
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - frameHandler
```
WebSocketBase frameHandler(Handler<WebSocketFrame> handler)
```
    Set a frame handler on the connection. This handler will be called when frames are read on the connection.
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - textMessageHandler
```
WebSocketBase textMessageHandler(Handler<String> handler)
```
    Set a text message handler on the connection. This handler will be called similar to the binaryMessageHandler(Handler), but the buffer will be converted to a String first
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - binaryMessageHandler
```
WebSocketBase binaryMessageHandler(Handler<Buffer> handler)
```
    Set a binary message handler on the connection. This handler serves a similar purpose to handler(Handler) except that if a message comes into the socket in multiple frames, the data from the frames will be aggregated into a single buffer before calling the handler (using WebSocketFrame.isFinal() to find the boundaries).
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - pongHandler
```
WebSocketBase pongHandler(Handler<Buffer> handler)
```
    Set a pong message handler on the connection. This handler will be invoked every time a pong message is received on the server, and can be used by both clients and servers since the RFC 6455 Sections 5.5.2 and 5.5.3 do not specify whether the client or server sends a ping.
    Pong frames may be at most 125 bytes (octets).
    There is no ping handler since pings should immediately be responded to with a pong with identical content
    Pong frames may be received unsolicited.
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - end
```
void end()
```
    Calls close()
    
    Specified by:
    
    end in interface WriteStream<Buffer>
  - close
```
void close()
```
    Close the WebSocket sending the default close frame.
    No more messages can be sent.
  - close
```
void close(short statusCode)
```
  - close
```
void close(short statusCode,
           String reason)
```
  - remoteAddress
```
SocketAddress remoteAddress()
```
    Returns:
    
    the remote address for this socket
  - localAddress
```
SocketAddress localAddress()
```
    Returns:
    
    the local address for this socket
  - isSsl
```
boolean isSsl()
```
    Returns:
    
    true if this HttpConnection is encrypted via SSL/TLS.
  - sslSession
```
SSLSession sslSession()
```
    Returns:
    
    SSLSession associated with the underlying socket. Returns null if connection is not SSL.
    
    See Also:
    
    SSLSession
  - peerCertificateChain
```
X509Certificate[] peerCertificateChain()
                                throws SSLPeerUnverifiedException
```
    Note: Java SE 5+ recommends to use javax.net.ssl.SSLSession#getPeerCertificates() instead of of javax.net.ssl.SSLSession#getPeerCertificateChain() which this method is based on. Use sslSession() to access that method.
    
    Returns:
    
    an ordered array of the peer certificates. Returns null if connection is not SSL.
    
    Throws:
    
    SSLPeerUnverifiedException - SSL peer's identity has not been verified.
    
    See Also:
    
    SSLSession.getPeerCertificateChain(), sslSession()

Interface WebSocketBase

Method Summary

Methods inherited from interface io.vertx.core.streams.WriteStream

Method Detail

exceptionHandler

handler

pause

resume

fetch

endHandler

write

setWriteQueueMaxSize

drainHandler

binaryHandlerID

textHandlerID

subProtocol

writeFrame

writeFinalTextFrame

writeFinalBinaryFrame

writeBinaryMessage

writeTextMessage

writePing

writePong

closeHandler

frameHandler

textMessageHandler

binaryMessageHandler

pongHandler

end

close

close

close

remoteAddress

localAddress

isSsl

sslSession

peerCertificateChain