public interface SockJSSocket extends ReadStream<Buffer>, WriteStream<Buffer>
The API is very similar to WebSocket.
It implements both ReadStream and WriteStream
so it can be used with
Pump to pump data with flow control.
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Close it
|
SockJSSocket |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
void |
end()
Call
end(). |
SockJSSocket |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
SockJSSocket |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
SockJSSocket |
handler(Handler<Buffer> handler)
Set a data handler.
|
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
|
SocketAddress |
localAddress()
Return the local address for this socket
|
SockJSSocket |
pause()
Pause the
ReadSupport. |
SocketAddress |
remoteAddress()
Return the remote address for this socket
|
SockJSSocket |
resume()
Resume reading.
|
SockJSSocket |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize. |
String |
uri()
Return the URI corresponding to the last request for this socket or the websocket handshake
|
Session |
webSession() |
User |
webUser() |
SockJSSocket |
write(Buffer data)
Write some data to the stream.
|
default SockJSSocket |
write(String data)
Write a
String to the socket, encoded in UTF-8. |
String |
writeHandlerID()
When a
SockJSSocket is created it automatically registers an event handler with the event bus, the ID of that
handler is given by writeHandlerID. |
end, writeQueueFullSockJSSocket exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBaseexceptionHandler in interface WriteStream<Buffer>handler - the exception handlerSockJSSocket handler(Handler<Buffer> handler)
ReadStreamhandler in interface ReadStream<Buffer>SockJSSocket pause()
ReadStreamReadSupport. While it's paused, no data will be sent to the dataHandlerpause in interface ReadStream<Buffer>SockJSSocket resume()
ReadStreamReadSupport has been paused, reading will recommence on it.resume in interface ReadStream<Buffer>SockJSSocket endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface ReadStream<Buffer>SockJSSocket write(Buffer data)
WriteStreamWriteStream.writeQueueFull() method before writing. This is done automatically if using a Pump.write in interface WriteStream<Buffer>data - the data to writedefault SockJSSocket write(String data)
String to the socket, encoded in UTF-8.data - the string to writeSockJSSocket setWriteQueueMaxSize(int maxSize)
WriteStreammaxSize. You will still be able to write to the stream even
if there is more than maxSize items in the write queue. This is used as an indicator by classes such as
Pump to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket, the number of Message for a
MessageProducer, etc...setWriteQueueMaxSize in interface WriteStream<Buffer>maxSize - the max size of the write streamSockJSSocket drainHandler(Handler<Void> handler)
WriteStreamPump for 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.drainHandler in interface WriteStream<Buffer>handler - the handlerString writeHandlerID()
SockJSSocket is created it automatically registers an event handler with the event bus, the ID of that
handler is given by writeHandlerID.
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.
void end()
end().end in interface WriteStream<Buffer>void close()
SocketAddress remoteAddress()
SocketAddress localAddress()
MultiMap headers()
String uri()
Session webSession()
User webUser()
Copyright © 2018. All rights reserved.