org.vertx.java.core.http

Interface ServerWebSocket

All Superinterfaces:

ExceptionSupport<ServerWebSocket>, ReadStream<ServerWebSocket>, WebSocketBase<ServerWebSocket>, WriteStream<ServerWebSocket>

public interface ServerWebSocket
extends WebSocketBase<ServerWebSocket>

Represents a server side WebSocket that is passed into a the websocketHandler of an HttpServer

Instances of this class are not thread-safe

Method Summary

Methods

Modifier and Type	Method and Description
MultiMap	headers() A map of all headers in the request to upgrade to websocket
java.lang.String	path() The path the websocket is attempting to connect at
ServerWebSocket	reject() Reject the WebSocket

Methods inherited from interface org.vertx.java.core.http.WebSocketBase

binaryHandlerID, close, closeHandler, textHandlerID, writeBinaryFrame, writeTextFrame

Methods inherited from interface org.vertx.java.core.streams.ReadStream

dataHandler, endHandler, pause, resume

Methods inherited from interface org.vertx.java.core.streams.WriteStream

drainHandler, setWriteQueueMaxSize, write, writeQueueFull

Methods inherited from interface org.vertx.java.core.streams.ExceptionSupport

exceptionHandler

Method Detail

path

java.lang.String path()

The path the websocket is attempting to connect at

headers

MultiMap headers()

A map of all headers in the request to upgrade to websocket

reject

ServerWebSocket reject()

Reject the WebSocket

Calling this method from the websocketHandler gives you the opportunity to reject the websocket, which will cause the websocket handshake to fail by returning a 404 response code.

You might use this method, if for example you only want to accept websockets with a particular path.