Class SockJSSocket
- java.lang.Object
-
- io.vertx.reactivex.ext.web.handler.sockjs.SockJSSocket
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,ReadStream<Buffer>,StreamBase,WriteStream<Buffer>
public class SockJSSocket extends Object implements io.vertx.lang.rx.RxDelegate, ReadStream<Buffer>, WriteStream<Buffer>
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<SockJSSocket>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description SockJSSocket(SockJSSocket delegate)SockJSSocket(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Close itvoidclose(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().Future<Void>end(Buffer data)Same asend(io.vertx.core.buffer.Buffer)but writes some data to the stream before ending.SockJSSocketendHandler(Handler<Void> endHandler)Set an end handler.booleanequals(Object o)SockJSSocketexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.SockJSSocketfetch(long amount)Fetch the specifiedamountof elements.SockJSSocketgetDelegate()SockJSSockethandler(Handler<Buffer> handler)Set a data handler.inthashCode()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 socketstatic SockJSSocketnewInstance(SockJSSocket arg)SockJSSocketpause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.Pipe<Buffer>pipe()Pause this stream and return a to transfer the elements of this stream to a destination .Future<Void>pipeTo(WriteStream<Buffer> dst)Pipe thisReadStreamto theWriteStream.SocketAddressremoteAddress()Return the remote address for this socketSockJSSocketresume()Resume reading, and sets the buffer inflowingmode.RoutingContextroutingContext()CompletablerxEnd()Callclose().CompletablerxEnd(Buffer data)Same asend(io.vertx.core.buffer.Buffer)but writes some data to the stream before ending.CompletablerxPipeTo(WriteStream<Buffer> dst)Pipe thisReadStreamto theWriteStream.CompletablerxWrite(Buffer data)Write some data to the stream.CompletablerxWrite(String data)Write aStringto the socket, encoded in UTF-8.SockJSSocketsetWriteQueueMaxSize(int maxSize)Set the maximum size of the write queue tomaxSize.Flowable<Buffer>toFlowable()Observable<Buffer>toObservable()WriteStreamObserver<Buffer>toObserver()StringtoString()WriteStreamSubscriber<Buffer>toSubscriber()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.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.booleanwriteQueueFull()This will returntrueif there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<SockJSSocket> __TYPE_ARG
-
-
Constructor Detail
-
SockJSSocket
public SockJSSocket(SockJSSocket delegate)
-
SockJSSocket
public SockJSSocket(Object delegate)
-
-
Method Detail
-
getDelegate
public SockJSSocket getDelegate()
- Specified by:
getDelegatein interfaceReadStream<Buffer>- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase- Specified by:
getDelegatein interfaceWriteStream<Buffer>
-
toObservable
public Observable<Buffer> toObservable()
- Specified by:
toObservablein interfaceReadStream<Buffer>
-
toFlowable
public Flowable<Buffer> toFlowable()
- Specified by:
toFlowablein interfaceReadStream<Buffer>
-
toObserver
public WriteStreamObserver<Buffer> toObserver()
- Specified by:
toObserverin interfaceWriteStream<Buffer>
-
toSubscriber
public WriteStreamSubscriber<Buffer> toSubscriber()
- Specified by:
toSubscriberin interfaceWriteStream<Buffer>
-
pipe
public Pipe<Buffer> pipe()
Pause this stream and return a to transfer the elements of this stream to a destination . The stream will be resumed when the pipe will be wired to aWriteStream.- Specified by:
pipein interfaceReadStream<Buffer>- Returns:
- a pipe
-
pipeTo
public Future<Void> pipeTo(WriteStream<Buffer> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
pipeToin interfaceReadStream<Buffer>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
rxPipeTo
public Completable rxPipeTo(WriteStream<Buffer> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
rxPipeToin interfaceReadStream<Buffer>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
end
public Future<Void> end(Buffer data)
Same asend(io.vertx.core.buffer.Buffer)but writes some data to the stream before ending.- Specified by:
endin interfaceWriteStream<Buffer>- Parameters:
data- the data to write- Returns:
- a future completed with the result
-
rxEnd
public Completable rxEnd(Buffer data)
Same asend(io.vertx.core.buffer.Buffer)but writes some data to the stream before ending.- Specified by:
rxEndin interfaceWriteStream<Buffer>- Parameters:
data- the data to write- Returns:
- a future completed with the result
-
writeQueueFull
public boolean writeQueueFull()
This will returntrueif there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)- Specified by:
writeQueueFullin interfaceWriteStream<Buffer>- Returns:
trueif write queue is full
-
exceptionHandler
public 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
public 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
public 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
public 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
public 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
public 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
public SockJSSocket closeHandler(Handler<Void> closeHandler)
-
write
public 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 returned 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.- Specified by:
writein interfaceWriteStream<Buffer>- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
rxWrite
public Completable rxWrite(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 returned 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.- Specified by:
rxWritein interfaceWriteStream<Buffer>- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
write
public Future<Void> write(String data)
Write aStringto the socket, encoded in UTF-8.- Parameters:
data- the string to write- Returns:
-
rxWrite
public Completable rxWrite(String data)
Write aStringto the socket, encoded in UTF-8.- Parameters:
data- the string to write- Returns:
-
setWriteQueueMaxSize
public 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
public 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
public 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
public Future<Void> end()
Callclose().- Specified by:
endin interfaceWriteStream<Buffer>- Returns:
-
rxEnd
public Completable rxEnd()
Callclose().- Specified by:
rxEndin interfaceWriteStream<Buffer>- Returns:
-
close
public void close()
Close it
-
close
public 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.- Parameters:
statusCode-reason-
-
remoteAddress
public SocketAddress remoteAddress()
Return the remote address for this socket- Returns:
-
localAddress
public SocketAddress localAddress()
Return the local address for this socket- Returns:
-
headers
public 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- Returns:
-
uri
public String uri()
Return the URI corresponding to the last request for this socket or the websocket handshake- Returns:
-
routingContext
public RoutingContext routingContext()
- Returns:
- the Vert.x-Web RoutingContext corresponding to this socket
-
webSession
public Session webSession()
- Returns:
- the Vert.x-Web session corresponding to this socket
-
webUser
public User webUser()
- Returns:
- the Vert.x-Web user corresponding to this socket
-
newInstance
public static SockJSSocket newInstance(SockJSSocket arg)
-
-