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
|
default void |
close(int statusCode,
String reason)
Close it giving a status code and reason.
|
SockJSSocket |
closeHandler(Handler<Void> closeHandler) |
SockJSSocket |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
Future<Void> |
end()
Call
close(). |
SockJSSocket |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
SockJSSocket |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
SockJSSocket |
fetch(long amount)
Fetch the specified
amount of elements. |
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
ReadStream, it sets the buffer in fetch mode and clears the actual demand. |
SocketAddress |
remoteAddress()
Return the remote address for this socket
|
SockJSSocket |
resume()
Resume reading, and sets the buffer in
flowing mode. |
RoutingContext |
routingContext() |
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() |
Future<Void> |
write(Buffer data)
Write some data to the stream.
|
default void |
write(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
#write(T) but with an handler called when the operation completes |
default Future<Void> |
write(String data)
Write a
String to the socket, encoded in UTF-8. |
default void |
write(String data,
Handler<AsyncResult<Void>> handler) |
String |
writeHandlerID()
When a
SockJSSocket is created it can register an event handler with the event bus, the ID of that
handler is given by writeHandlerID. |
pipe, pipeTo, pipeToend, end, 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()
ReadStreamReadStream, it sets the buffer in fetch mode and clears the actual demand.
While it's paused, no data will be sent to the data handler.
pause in interface ReadStream<Buffer>SockJSSocket resume()
ReadStreamflowing mode.
If the ReadStream has been paused, reading will recommence on it.resume in interface ReadStream<Buffer>SockJSSocket fetch(long amount)
ReadStreamamount of elements. If the ReadStream has been paused, reading will
recommence with the specified amount of items, otherwise the specified amount will
be added to the current stream demand.fetch in interface ReadStream<Buffer>SockJSSocket endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface ReadStream<Buffer>SockJSSocket closeHandler(Handler<Void> closeHandler)
Future<Void> write(Buffer data)
WriteStream 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 a Pipe.
When the data is moved from the queue to the actual medium, the returned
Future will 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.
write in interface WriteStream<Buffer>data - the data to writedefault Future<Void> write(String data)
String to the socket, encoded in UTF-8.data - the string to writedefault void write(String data, Handler<AsyncResult<Void>> handler)
default void write(Buffer data, Handler<AsyncResult<Void>> handler)
WriteStream#write(T) but with an handler called when the operation completeswrite in interface WriteStream<Buffer>SockJSSocket 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
Pipe to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket, etc...setWriteQueueMaxSize in interface WriteStream<Buffer>maxSize - the max size of the write streamSockJSSocket drainHandler(Handler<Void> handler)
WriteStreamPipe 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 can register 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.
writeHandlerID or null if writeHandler registration is disabled in SockJSHandlerOptionsFuture<Void> end()
close().end in interface WriteStream<Buffer>void close()
default void close(int statusCode,
String reason)
SocketAddress remoteAddress()
SocketAddress localAddress()
MultiMap headers()
String uri()
RoutingContext routingContext()
Session webSession()
User webUser()
Copyright © 2024 Eclipse. All rights reserved.