Package io.vertx.core.http
Interface ServerWebSocket
-
- All Superinterfaces:
ReadStream<Buffer>,StreamBase,WebSocket,WebSocketBase,WriteStream<Buffer>
public interface ServerWebSocket extends WebSocket
Represents a server side WebSocket.Instances of this class are passed into a
HttpServer.webSocketHandler(io.vertx.core.Handler<io.vertx.core.http.ServerWebSocket>)or provided when a WebSocket handshake is manuallyHttpServerRequest.toWebSocket()ed.- Author:
- Tim Fox
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description HostAndPortauthority()default Future<Void>close()Close the WebSocket sending the default close frame.ServerWebSocketcloseHandler(Handler<Void> handler)Set a close handler.ServerWebSocketdrainHandler(Handler<Void> handler)Set a drain handler on the stream.ServerWebSocketendHandler(Handler<Void> endHandler)Set an end handler.ServerWebSocketexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.ServerWebSocketfetch(long amount)Fetch the specifiedamountof elements.ServerWebSocketframeHandler(Handler<WebSocketFrame> handler)Set a frame handler on the connection.ServerWebSockethandler(Handler<Buffer> handler)Set a data handler.Stringpath()ServerWebSocketpause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.Stringquery()default ServerWebSocketresume()Resume reading, and sets the buffer inflowingmode.Stringscheme()ServerWebSocketsetWriteQueueMaxSize(int maxSize)Set the maximum size of the write queue tomaxSize.SSLSessionsslSession()Stringuri()-
Methods inherited from interface io.vertx.core.streams.ReadStream
blockingStream, collect, pipe, pipeTo
-
Methods inherited from interface io.vertx.core.http.WebSocket
binaryMessageHandler, pongHandler, shutdownHandler, textMessageHandler
-
Methods inherited from interface io.vertx.core.http.WebSocketBase
binaryHandlerID, close, close, closeReason, closeStatusCode, end, headers, isClosed, isSsl, localAddress, peerCertificates, remoteAddress, shutdown, shutdown, shutdown, shutdown, shutdown, shutdown, subProtocol, textHandlerID, writeBinaryMessage, writeFinalBinaryFrame, writeFinalTextFrame, writeFrame, writePing, writePong, writeTextMessage
-
Methods inherited from interface io.vertx.core.streams.WriteStream
end, write, writeQueueFull
-
-
-
-
Method Detail
-
exceptionHandler
ServerWebSocket exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<Buffer>- Specified by:
exceptionHandlerin interfaceStreamBase- Specified by:
exceptionHandlerin interfaceWebSocket- Specified by:
exceptionHandlerin interfaceWebSocketBase- Specified by:
exceptionHandlerin interfaceWriteStream<Buffer>- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
ServerWebSocket handler(Handler<Buffer> handler)
Description copied from interface:ReadStreamSet a data handler. As data is read, the handler will be called with the data.- Specified by:
handlerin interfaceReadStream<Buffer>- Specified by:
handlerin interfaceWebSocket- Specified by:
handlerin interfaceWebSocketBase- Returns:
- a reference to this, so the API can be used fluently
-
pause
ServerWebSocket pause()
Description copied from interface:ReadStreamPause theReadStream, it sets the buffer infetchmode and clears the actual demand.While it's paused, no data will be sent to the data
handler.- Specified by:
pausein interfaceReadStream<Buffer>- Specified by:
pausein interfaceWebSocket- Specified by:
pausein interfaceWebSocketBase- Returns:
- a reference to this, so the API can be used fluently
-
resume
default ServerWebSocket resume()
Description copied from interface:ReadStreamResume reading, and sets the buffer inflowingmode. If theReadStreamhas been paused, reading will recommence on it.- Specified by:
resumein interfaceReadStream<Buffer>- Specified by:
resumein interfaceWebSocket- Specified by:
resumein interfaceWebSocketBase- Returns:
- a reference to this, so the API can be used fluently
-
fetch
ServerWebSocket fetch(long amount)
Description copied from interface:ReadStreamFetch the specifiedamountof elements. If theReadStreamhas been paused, reading will recommence with the specifiedamountof items, otherwise the specifiedamountwill be added to the current stream demand.- Specified by:
fetchin interfaceReadStream<Buffer>- Specified by:
fetchin interfaceWebSocket- Specified by:
fetchin interfaceWebSocketBase- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
ServerWebSocket endHandler(Handler<Void> endHandler)
Description copied from interface:ReadStreamSet an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandlerin interfaceReadStream<Buffer>- Specified by:
endHandlerin interfaceWebSocket- Specified by:
endHandlerin interfaceWebSocketBase- Returns:
- a reference to this, so the API can be used fluently
-
setWriteQueueMaxSize
ServerWebSocket setWriteQueueMaxSize(int maxSize)
Description copied from interface:WriteStreamSet the maximum size of the write queue tomaxSize. You will still be able to write to the stream even if there is more thanmaxSizeitems in the write queue. This is used as an indicator by classes such asPipeto provide flow control. The value is defined by the implementation of the stream, e.g in bytes for aNetSocket, etc...- Specified by:
setWriteQueueMaxSizein interfaceWebSocket- Specified by:
setWriteQueueMaxSizein interfaceWebSocketBase- Specified by:
setWriteQueueMaxSizein interfaceWriteStream<Buffer>- Parameters:
maxSize- the max size of the write stream- Returns:
- a reference to this, so the API can be used fluently
-
drainHandler
ServerWebSocket drainHandler(Handler<Void> handler)
Description copied from interface:WriteStreamSet 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. SeePipefor 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:
drainHandlerin interfaceWebSocket- Specified by:
drainHandlerin interfaceWebSocketBase- Specified by:
drainHandlerin interfaceWriteStream<Buffer>- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
closeHandler
ServerWebSocket closeHandler(Handler<Void> handler)
Description copied from interface:WebSocketBaseSet a close handler. This will be called when the WebSocket is closed. After this callback, no more messages are expected. When the WebSocket received a close frame, theWebSocketBase.closeStatusCode()will return the status code andWebSocketBase.closeReason()will return the reason.- Specified by:
closeHandlerin interfaceWebSocket- Specified by:
closeHandlerin interfaceWebSocketBase- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
frameHandler
ServerWebSocket frameHandler(Handler<WebSocketFrame> handler)
Description copied from interface:WebSocketBaseSet a frame handler on the connection. This handler will be called when frames are read on the connection.- Specified by:
frameHandlerin interfaceWebSocket- Specified by:
frameHandlerin interfaceWebSocketBase- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
scheme
String scheme()
- Returns:
- the WebSocket handshake scheme
-
authority
HostAndPort authority()
- Returns:
- the WebSocket handshake authority
-
uri
String uri()
-
path
String path()
- Returns:
- the WebSocket handshake path.
-
query
String query()
- Returns:
- the WebSocket handshake query string.
-
close
default Future<Void> close()
Close the WebSocket sending the default close frame. No more messages can be sent.The WebSocket handshake will be accepted when it hasn't yet been settled or when an asynchronous handshake is in progress.
- Specified by:
closein interfaceWebSocketBase- Returns:
- a future completed with the result
-
sslSession
SSLSession sslSession()
- Specified by:
sslSessionin interfaceWebSocketBase- Returns:
- SSLSession associated with the underlying socket. Returns null if connection is not SSL.
- See Also:
SSLSession
-
-