Package io.vertx.core.http
Interface WebSocket
-
- All Superinterfaces:
ReadStream<Buffer>,StreamBase,WebSocketBase,WriteStream<Buffer>
- All Known Subinterfaces:
ClientWebSocket,ServerWebSocket
public interface WebSocket extends WebSocketBase
Common WebSocket implementation.It implements both
ReadStreamandWriteStreamso it can be used withPipeto pipe data with flow control.- Author:
- Tim Fox
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description WebSocketbinaryMessageHandler(Handler<Buffer> handler)Set a binary message handler on the connection.WebSocketcloseHandler(Handler<Void> handler)Set a close handler.WebSocketdrainHandler(Handler<Void> handler)Set a drain handler on the stream.WebSocketendHandler(Handler<Void> endHandler)Set an end handler.WebSocketexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.WebSocketfetch(long amount)Fetch the specifiedamountof elements.WebSocketframeHandler(Handler<WebSocketFrame> handler)Set a frame handler on the connection.WebSockethandler(Handler<Buffer> handler)Set a data handler.WebSocketpause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.WebSocketpongHandler(Handler<Buffer> handler)Set a pong frame handler on the connection.default WebSocketresume()Resume reading, and sets the buffer inflowingmode.WebSocketsetWriteQueueMaxSize(int maxSize)Set the maximum size of the write queue tomaxSize.WebSocketshutdownHandler(Handler<Void> handler)Set ahandlernotified when the WebSocket is shutdown: the client or server will close the connection within a certain amount of time.WebSockettextMessageHandler(Handler<String> handler)Set a text message handler on the connection.-
Methods inherited from interface io.vertx.core.streams.ReadStream
blockingStream, collect, pipe, pipeTo
-
Methods inherited from interface io.vertx.core.http.WebSocketBase
binaryHandlerID, close, close, close, closeReason, closeStatusCode, end, headers, isClosed, isSsl, localAddress, peerCertificates, remoteAddress, shutdown, shutdown, shutdown, shutdown, shutdown, shutdown, sslSession, subProtocol, textHandlerID, writeBinaryMessage, writeFinalBinaryFrame, writeFinalTextFrame, writeFrame, writePing, writePong, writeTextMessage
-
Methods inherited from interface io.vertx.core.streams.WriteStream
end, write, writeQueueFull
-
-
-
-
Method Detail
-
exceptionHandler
WebSocket 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 interfaceWebSocketBase- Specified by:
exceptionHandlerin interfaceWriteStream<Buffer>- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
WebSocket 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 interfaceWebSocketBase- Returns:
- a reference to this, so the API can be used fluently
-
pause
WebSocket 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 interfaceWebSocketBase- Returns:
- a reference to this, so the API can be used fluently
-
resume
default WebSocket 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 interfaceWebSocketBase- Returns:
- a reference to this, so the API can be used fluently
-
fetch
WebSocket 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 interfaceWebSocketBase- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
WebSocket 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 interfaceWebSocketBase- Returns:
- a reference to this, so the API can be used fluently
-
setWriteQueueMaxSize
WebSocket 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 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
WebSocket 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 interfaceWebSocketBase- Specified by:
drainHandlerin interfaceWriteStream<Buffer>- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
closeHandler
WebSocket 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 interfaceWebSocketBase- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
shutdownHandler
WebSocket shutdownHandler(Handler<Void> handler)
Description copied from interface:WebSocketBaseSet ahandlernotified when the WebSocket is shutdown: the client or server will close the connection within a certain amount of time. This gives the opportunity to thehandlerto close the WebSocket gracefully before the WebSocket is forcefully closed.- Specified by:
shutdownHandlerin interfaceWebSocketBase- Parameters:
handler- the handler notified with the remaining shutdown- Returns:
- a reference to this, so the API can be used fluently
-
frameHandler
WebSocket 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 interfaceWebSocketBase- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
textMessageHandler
WebSocket textMessageHandler(Handler<String> handler)
Description copied from interface:WebSocketBaseSet a text message handler on the connection. This handler will be called similar to theWebSocketBase.binaryMessageHandler(Handler), but the buffer will be converted to a String first- Specified by:
textMessageHandlerin interfaceWebSocketBase- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
binaryMessageHandler
WebSocket binaryMessageHandler(Handler<Buffer> handler)
Description copied from interface:WebSocketBaseSet a binary message handler on the connection. This handler serves a similar purpose toWebSocketBase.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 (usingWebSocketFrame.isFinal()to find the boundaries).- Specified by:
binaryMessageHandlerin interfaceWebSocketBase- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
pongHandler
WebSocket pongHandler(Handler<Buffer> handler)
Description copied from interface:WebSocketBaseSet a pong frame handler on the connection. This handler will be invoked every time a pong frame is received on the server, and can be used by both clients and servers since the RFC 6455 section 5.5.2 and section 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 ping frames should immediately be responded to with a pong frame with identical content
Pong frames may be received unsolicited.
- Specified by:
pongHandlerin interfaceWebSocketBase- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
-