Class SockJSSocket
- java.lang.Object
-
- io.vertx.mutiny.ext.web.handler.sockjs.SockJSSocket
-
- All Implemented Interfaces:
ReadStream<Buffer>
,StreamBase
,WriteStream<Buffer>
public class SockJSSocket extends Object implements ReadStream<Buffer>, WriteStream<Buffer>
You interact with SockJS clients through instances of SockJS socket.The API is very similar to
WebSocket
. It implements both and so it can be used withPump
to pump data with flow control.original
non Mutiny-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.smallrye.mutiny.vertx.TypeArg<SockJSSocket>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description SockJSSocket(io.vertx.ext.web.handler.sockjs.SockJSSocket delegate)
SockJSSocket(Object delegate)
-
Method Summary
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.smallrye.mutiny.vertx.TypeArg<SockJSSocket> __TYPE_ARG
-
-
Constructor Detail
-
SockJSSocket
public SockJSSocket(io.vertx.ext.web.handler.sockjs.SockJSSocket delegate)
-
SockJSSocket
public SockJSSocket(Object delegate)
-
-
Method Detail
-
getDelegate
public io.vertx.ext.web.handler.sockjs.SockJSSocket getDelegate()
- Specified by:
getDelegate
in interfaceReadStream<Buffer>
- Specified by:
getDelegate
in interfaceStreamBase
- Specified by:
getDelegate
in interfaceWriteStream<Buffer>
-
toSubscriber
@CheckReturnValue public io.smallrye.mutiny.vertx.WriteStreamSubscriber<Buffer> toSubscriber()
-
end
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> end()
- Specified by:
end
in interfaceWriteStream<Buffer>
-
endAndAwait
public Void endAndAwait()
- Specified by:
endAndAwait
in interfaceWriteStream<Buffer>
-
endAndForget
public void endAndForget()
- Specified by:
endAndForget
in interfaceWriteStream<Buffer>
-
end
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> end(Buffer data)
- Specified by:
end
in interfaceWriteStream<Buffer>
-
endAndAwait
public Void endAndAwait(Buffer data)
- Specified by:
endAndAwait
in interfaceWriteStream<Buffer>
-
endAndForget
public void endAndForget(Buffer data)
- Specified by:
endAndForget
in interfaceWriteStream<Buffer>
-
writeQueueFull
public boolean writeQueueFull()
- Specified by:
writeQueueFull
in interfaceWriteStream<Buffer>
-
pipe
public Pipe<Buffer> pipe()
- Specified by:
pipe
in interfaceReadStream<Buffer>
-
pipeTo
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> pipeTo(WriteStream<Buffer> dst)
- Specified by:
pipeTo
in interfaceReadStream<Buffer>
-
pipeToAndAwait
public Void pipeToAndAwait(WriteStream<Buffer> dst)
- Specified by:
pipeToAndAwait
in interfaceReadStream<Buffer>
-
pipeToAndForget
public void pipeToAndForget(WriteStream<Buffer> dst)
- Specified by:
pipeToAndForget
in interfaceReadStream<Buffer>
-
exceptionHandler
public SockJSSocket exceptionHandler(Consumer<Throwable> handler)
- Specified by:
exceptionHandler
in interfaceReadStream<Buffer>
- Specified by:
exceptionHandler
in interfaceStreamBase
- Specified by:
exceptionHandler
in interfaceWriteStream<Buffer>
-
handler
public SockJSSocket handler(Consumer<Buffer> handler)
- Specified by:
handler
in interfaceReadStream<Buffer>
-
pause
public SockJSSocket pause()
- Specified by:
pause
in interfaceReadStream<Buffer>
-
resume
public SockJSSocket resume()
- Specified by:
resume
in interfaceReadStream<Buffer>
-
fetch
public SockJSSocket fetch(long amount)
- Specified by:
fetch
in interfaceReadStream<Buffer>
-
endHandler
public SockJSSocket endHandler(Runnable endHandler)
- Specified by:
endHandler
in interfaceReadStream<Buffer>
-
closeHandler
public SockJSSocket closeHandler(Runnable closeHandler)
-
writeAndForget
public void writeAndForget(String data)
-
write
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> write(Buffer data)
- Specified by:
write
in interfaceWriteStream<Buffer>
-
writeAndAwait
public Void writeAndAwait(Buffer data)
- Specified by:
writeAndAwait
in interfaceWriteStream<Buffer>
-
writeAndForget
public void writeAndForget(Buffer data)
- Specified by:
writeAndForget
in interfaceWriteStream<Buffer>
-
setWriteQueueMaxSize
public SockJSSocket setWriteQueueMaxSize(int maxSize)
- Specified by:
setWriteQueueMaxSize
in interfaceWriteStream<Buffer>
-
drainHandler
public SockJSSocket drainHandler(Runnable handler)
- Specified by:
drainHandler
in interfaceWriteStream<Buffer>
-
writeHandlerID
public String writeHandlerID()
- Returns:
- the
writeHandlerID
ornull
ifwriteHandler
registration is disabled inSockJSHandlerOptions
-
close
public void close()
-
close
public void close(int statusCode, String reason)
- Parameters:
statusCode
-reason
-
-
remoteAddress
public SocketAddress remoteAddress()
- Returns:
-
localAddress
public SocketAddress localAddress()
- Returns:
-
headers
public MultiMap headers()
- Returns:
-
uri
public String uri()
- 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
-
toMulti
@CheckReturnValue public io.smallrye.mutiny.Multi<Buffer> toMulti()
- Specified by:
toMulti
in interfaceReadStream<Buffer>
-
newInstance
public static SockJSSocket newInstance(io.vertx.ext.web.handler.sockjs.SockJSSocket arg)
-
-