Interface SockJSSocket
-
- All Superinterfaces:
ReadStream<Buffer>,StreamBase,WriteStream<Buffer>
public interface SockJSSocket extends ReadStream<Buffer>, WriteStream<Buffer>
You interact with SockJS clients through instances of SockJS socket.The API is very similar to
WebSocket. It implements bothReadStreamandWriteStreamso it can be used withio.vertx.core.streams.Pumpto pump data with flow control.- Author:
- Tim Fox
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description voidclose()Close itdefault voidclose(int statusCode, String reason)Close it giving a status code and reason.SockJSSocketcloseHandler(Handler<Void> closeHandler)SockJSSocketdrainHandler(Handler<Void> handler)Set a drain handler on the stream.Future<Void>end()Callclose().SockJSSocketendHandler(Handler<Void> endHandler)Set an end handler.SockJSSocketexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.SockJSSocketfetch(long amount)Fetch the specifiedamountof elements.SockJSSockethandler(Handler<Buffer> handler)Set a data handler.MultiMapheaders()Return the headers corresponding to the last request for this socket or the websocket handshake Any cookie headers will be removed for security reasonsSocketAddresslocalAddress()Return the local address for this socketSockJSSocketpause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.SocketAddressremoteAddress()Return the remote address for this socketSockJSSocketresume()Resume reading, and sets the buffer inflowingmode.RoutingContextroutingContext()SockJSSocketsetWriteQueueMaxSize(int maxSize)Set the maximum size of the write queue tomaxSize.Stringuri()Return the URI corresponding to the last request for this socket or the websocket handshakeSessionwebSession()UserwebUser()Future<Void>write(Buffer data)Write some data to the stream.default Future<Void>write(String data)Write aStringto the socket, encoded in UTF-8.StringwriteHandlerID()When aSockJSSocketis created it can register an event handler with the event bus, the ID of that handler is given bywriteHandlerID.-
Methods inherited from interface io.vertx.core.streams.ReadStream
blockingStream, collect, pipe, pipeTo
-
Methods inherited from interface io.vertx.core.streams.WriteStream
end, writeQueueFull
-
-
-
-
Method Detail
-
exceptionHandler
SockJSSocket 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 interfaceWriteStream<Buffer>- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
SockJSSocket 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>- Returns:
- a reference to this, so the API can be used fluently
-
pause
SockJSSocket 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>- Returns:
- a reference to this, so the API can be used fluently
-
resume
SockJSSocket 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>- Returns:
- a reference to this, so the API can be used fluently
-
fetch
SockJSSocket 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>- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
SockJSSocket 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>- Returns:
- a reference to this, so the API can be used fluently
-
closeHandler
SockJSSocket closeHandler(Handler<Void> closeHandler)
-
write
Future<Void> write(Buffer data)
Description copied from interface:WriteStreamWrite some data to the stream.The data is usually 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 aPipe.When the
datais moved from the queue to the actual medium, the returnedFuturewill be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.- Specified by:
writein interfaceWriteStream<Buffer>- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
write
default Future<Void> write(String data)
Write aStringto the socket, encoded in UTF-8.- Parameters:
data- the string to write
-
setWriteQueueMaxSize
SockJSSocket 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 interfaceWriteStream<Buffer>- Parameters:
maxSize- the max size of the write stream- Returns:
- a reference to this, so the API can be used fluently
-
drainHandler
SockJSSocket 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 interfaceWriteStream<Buffer>- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
writeHandlerID
String writeHandlerID()
When aSockJSSocketis created it can register an event handler with the event bus, the ID of that handler is given bywriteHandlerID.Given this ID, a different event loop can send a buffer 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 socket. This allows you to write data to other sockets which are owned by different event loops.
- Returns:
- the
writeHandlerIDornullifwriteHandlerregistration is disabled inSockJSHandlerOptions
-
end
Future<Void> end()
Callclose().- Specified by:
endin interfaceWriteStream<Buffer>- Returns:
- a future completed with the result
-
close
void close()
Close it
-
close
default void close(int statusCode, String reason)Close it giving a status code and reason. Only Applicable to RawWebSocket will downgrade to plain close for other transports.
-
remoteAddress
SocketAddress remoteAddress()
Return the remote address for this socket
-
localAddress
SocketAddress localAddress()
Return the local address for this socket
-
headers
MultiMap headers()
Return the headers corresponding to the last request for this socket or the websocket handshake Any cookie headers will be removed for security reasons
-
uri
String uri()
Return the URI corresponding to the last request for this socket or the websocket handshake
-
routingContext
RoutingContext routingContext()
- Returns:
- the Vert.x-Web RoutingContext corresponding to this socket
-
webSession
Session webSession()
- Returns:
- the Vert.x-Web session corresponding to this socket
-
webUser
User webUser()
- Returns:
- the Vert.x-Web user corresponding to this socket
-
-