Class: ServerWebSocket

vertx-js/server_web_socket~ ServerWebSocket

new ServerWebSocket()

Represents a server side WebSocket.

Source:

Methods

accept()

Accept the WebSocket and terminate the WebSocket handshake.

This method should be called from the websocket handler to explicitely accept the websocker and terminate the WebSocket handshake.

Source:

binaryHandlerID() → {string}

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.

Source:
Returns:
the binary handler id
Type
string

binaryMessageHandler(handler) → {WebSocketBase}

Set a binary message handler on the connection. This handler serves a similar purpose to ServerWebSocket#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:
Name Type Description
handler function the handler
Source:
Returns:
a reference to this, so the API can be used fluently
Type
WebSocketBase

close()

Close the WebSocket.
Source:

closeHandler(handler) → {ServerWebSocket}

Parameters:
Name Type Description
handler function
Source:
Returns:
Type
ServerWebSocket

drainHandler(handler) → {ServerWebSocket}

Parameters:
Name Type Description
handler function
Source:
Returns:
Type
ServerWebSocket

end(t)

Same as WebSocketBase#end but writes some data to the stream before ending.
Parameters:
Name Type Description
t Buffer
Source:

endHandler(endHandler) → {ServerWebSocket}

Parameters:
Name Type Description
endHandler function
Source:
Returns:
Type
ServerWebSocket

exceptionHandler(handler) → {ServerWebSocket}

Parameters:
Name Type Description
handler function
Source:
Returns:
Type
ServerWebSocket

frameHandler(handler) → {ServerWebSocket}

Parameters:
Name Type Description
handler function
Source:
Returns:
Type
ServerWebSocket

handler(handler) → {ServerWebSocket}

Parameters:
Name Type Description
handler function
Source:
Returns:
Type
ServerWebSocket

headers() → {MultiMap}

Source:
Returns:
the headers in the WebSocket handshake
Type
MultiMap

isSsl() → {boolean}

Source:
Returns:
true if this HttpConnection is encrypted via SSL/TLS.
Type
boolean

localAddress() → {SocketAddress}

Source:
Returns:
the local address for this socket
Type
SocketAddress

path() → {string}

Source:
Returns:
the WebSocket handshake path.
Type
string

pause() → {ServerWebSocket}

Source:
Returns:
Type
ServerWebSocket

pongHandler(handler) → {WebSocketBase}

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:
Name Type Description
handler function the handler
Source:
Returns:
a reference to this, so the API can be used fluently
Type
WebSocketBase

query() → {string}

Source:
Returns:
the WebSocket handshake query string.
Type
string

reject(status)

Like ServerWebSocket#reject but with a status.
Parameters:
Name Type Description
status number
Source:

remoteAddress() → {SocketAddress}

Source:
Returns:
the remote address for this socket
Type
SocketAddress

resume() → {ServerWebSocket}

Source:
Returns:
Type
ServerWebSocket

setWriteQueueMaxSize(maxSize) → {ServerWebSocket}

Parameters:
Name Type Description
maxSize number
Source:
Returns:
Type
ServerWebSocket

subProtocol() → {string}

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.

Source:
Returns:
Type
string

textHandlerID() → {string}

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.

Source:
Returns:
Type
string

textMessageHandler(handler) → {WebSocketBase}

Set a text message handler on the connection. This handler will be called similar to the , but the buffer will be converted to a String first
Parameters:
Name Type Description
handler function the handler
Source:
Returns:
a reference to this, so the API can be used fluently
Type
WebSocketBase

uri() → {string}

Source:
Returns:
Type
string

write(data) → {ServerWebSocket}

Parameters:
Name Type Description
data Buffer
Source:
Returns:
Type
ServerWebSocket

writeBinaryMessage(data) → {ServerWebSocket}

Parameters:
Name Type Description
data Buffer
Source:
Returns:
Type
ServerWebSocket

writeFinalBinaryFrame(data) → {ServerWebSocket}

Parameters:
Name Type Description
data Buffer
Source:
Returns:
Type
ServerWebSocket

writeFinalTextFrame(text) → {ServerWebSocket}

Parameters:
Name Type Description
text string
Source:
Returns:
Type
ServerWebSocket

writeFrame(frame) → {ServerWebSocket}

Parameters:
Name Type Description
frame WebSocketFrame
Source:
Returns:
Type
ServerWebSocket

writePing(data) → {WebSocketBase}

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:
Name Type Description
data Buffer the data to write, may be at most 125 bytes
Source:
Returns:
a reference to this, so the API can be used fluently
Type
WebSocketBase

writePong(data) → {WebSocketBase}

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:
Name Type Description
data Buffer the data to write, may be at most 125 bytes
Source:
Returns:
a reference to this, so the API can be used fluently
Type
WebSocketBase

writeQueueFull() → {boolean}

This will return true if there are more bytes in the write queue than the value set using ServerWebSocket#setWriteQueueMaxSize
Source:
Returns:
true if write queue is full
Type
boolean

writeTextMessage(text) → {WebSocketBase}

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:
Name Type Description
text string the data to write
Source:
Returns:
a reference to this, so the API can be used fluently
Type
WebSocketBase