Class NetSocket
- java.lang.Object
-
- io.vertx.rxjava3.core.net.NetSocket
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,ReadStream<Buffer>,StreamBase,WriteStream<Buffer>
public class NetSocket extends Object implements io.vertx.lang.rx.RxDelegate, ReadStream<Buffer>, WriteStream<Buffer>
Represents a socket-like interface to a TCP connection on either the client or the server side.Instances of this class are created on the client side by an
NetClientwhen a connection to a server is made, or on the server side by aNetServerwhen a server accepts a connection.It implements both and so it can be used with
Pipeto pipe data with flow control.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<NetSocket>__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringapplicationLayerProtocol()Completableclose()Close the socketNetSocketcloseHandler(Handler<Void> handler)Set ahandlernotified when the socket is closedNetSocketdrainHandler(Handler<Void> handler)Set a drain handler on the stream.Completableend()Callsclose()Completableend(Buffer data)Same asend(io.vertx.core.buffer.Buffer)but writes some data to the stream before ending.NetSocketendHandler(Handler<Void> endHandler)This handler might be called after the close handler when the socket is paused and there are still buffers to deliver.booleanequals(Object o)NetSocketexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.NetSocketfetch(long amount)Fetch the specifiedamountof elements.NetSocketgetDelegate()NetSockethandler(Handler<Buffer> handler)Set a data handler.inthashCode()StringindicatedServerName()Returns the SNI server name presented during the SSL handshake by the client.booleanisSsl()SocketAddresslocalAddress()SocketAddresslocalAddress(boolean real)static NetSocketnewInstance(NetSocket arg)NetSocketpause()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 .CompletablepipeTo(WriteStream<Buffer> dst)Pipe thisReadStreamto theWriteStream.SocketAddressremoteAddress()SocketAddressremoteAddress(boolean real)NetSocketresume()Resume reading, and sets the buffer inflowingmode.CompletablerxClose()Close the socketCompletablerxEnd()Callsclose()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.CompletablerxSendFile(String filename)Tell the operating system to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.CompletablerxSendFile(String filename, long offset)Tell the operating system to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.CompletablerxSendFile(String filename, long offset, long length)Tell the operating system to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.CompletablerxUpgradeToSsl()LikeupgradeToSsl()with the default SSL options, without indicating a server name, without an upgrade message.CompletablerxUpgradeToSsl(Buffer msg)LikeupgradeToSsl()with the default SSL options and without indicating a server name.CompletablerxUpgradeToSsl(SSLOptions sslOptions)Upgrade channel to use SSL/TLS.CompletablerxUpgradeToSsl(SSLOptions sslOptions, Buffer msg)LikeupgradeToSsl()without indicating a server nameCompletablerxUpgradeToSsl(SSLOptions sslOptions, String serverName)LikeupgradeToSsl()without an upgrade message.CompletablerxUpgradeToSsl(SSLOptions sslOptions, String serverName, Buffer upgrade)Upgrade the channel to use SSL/TLS, in other words proceeds to the TLS handshake.CompletablerxUpgradeToSsl(String serverName)LikeupgradeToSsl()with the default SSL options and without an update message.CompletablerxUpgradeToSsl(String serverName, Buffer msg)LikeupgradeToSsl()with the default SSL options.CompletablerxWrite(Buffer data)Write some data to the stream.CompletablerxWrite(String str)Write aStringto the connection, encoded in UTF-8.CompletablerxWrite(String str, String enc)Write aStringto the connection, encoded using the encodingenc.CompletablesendFile(String filename)Tell the operating system to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.CompletablesendFile(String filename, long offset)Tell the operating system to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.CompletablesendFile(String filename, long offset, long length)Tell the operating system to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.NetSocketsetWriteQueueMaxSize(int maxSize)Set the maximum size of the write queue tomaxSize.NetSocketshutdownHandler(Handler<Void> handler)Set ahandlernotified when the socket is shutdown: the client or server will close the connection within a certain amount of time.SSLSessionsslSession()Flowable<Buffer>toFlowable()Observable<Buffer>toObservable()WriteStreamObserver<Buffer>toObserver()StringtoString()WriteStreamSubscriber<Buffer>toSubscriber()CompletableupgradeToSsl()LikeupgradeToSsl()with the default SSL options, without indicating a server name, without an upgrade message.CompletableupgradeToSsl(Buffer msg)LikeupgradeToSsl()with the default SSL options and without indicating a server name.CompletableupgradeToSsl(SSLOptions sslOptions)Upgrade channel to use SSL/TLS.CompletableupgradeToSsl(SSLOptions sslOptions, Buffer msg)LikeupgradeToSsl()without indicating a server nameCompletableupgradeToSsl(SSLOptions sslOptions, String serverName)LikeupgradeToSsl()without an upgrade message.CompletableupgradeToSsl(SSLOptions sslOptions, String serverName, Buffer upgrade)Upgrade the channel to use SSL/TLS, in other words proceeds to the TLS handshake.CompletableupgradeToSsl(String serverName)LikeupgradeToSsl()with the default SSL options and without an update message.CompletableupgradeToSsl(String serverName, Buffer msg)LikeupgradeToSsl()with the default SSL options.Completablewrite(Buffer data)Write some data to the stream.Completablewrite(String str)Write aStringto the connection, encoded in UTF-8.Completablewrite(String str, String enc)Write aStringto the connection, encoded using the encodingenc.StringwriteHandlerID()When aNetSocketis created, it may 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<NetSocket> __TYPE_ARG
-
-
Method Detail
-
getDelegate
public NetSocket 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 Completable 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
-
write
public Completable write(Buffer data)
Write 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 a .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)
Write 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 a .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
-
end
public Completable 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 NetSocket 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 NetSocket 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 NetSocket 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 NetSocket 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 NetSocket 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 NetSocket endHandler(Handler<Void> endHandler)
This handler might be called after the close handler when the socket is paused and there are still buffers to deliver.
- Specified by:
endHandlerin interfaceReadStream<Buffer>- Parameters:
endHandler-- Returns:
-
setWriteQueueMaxSize
public NetSocket 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 NetSocket 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 aNetSocketis created, it may register an event handler with the event bus, the ID of that handler is given bywriteHandlerID.By default, no handler is registered, the feature must be enabled via
NetClientOptionsorNetServerOptions.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 connection. This allows you to write data to other connections which are owned by different event loops.
- Returns:
- the write handler ID
-
write
public Completable write(String str)
Write aStringto the connection, encoded in UTF-8.- Parameters:
str- the string to write- Returns:
- a future result of the write
-
rxWrite
public Completable rxWrite(String str)
Write aStringto the connection, encoded in UTF-8.- Parameters:
str- the string to write- Returns:
- a future result of the write
-
write
public Completable write(String str, String enc)
Write aStringto the connection, encoded using the encodingenc.- Parameters:
str- the string to writeenc- the encoding to use- Returns:
- a future completed with the result
-
rxWrite
public Completable rxWrite(String str, String enc)
Write aStringto the connection, encoded using the encodingenc.- Parameters:
str- the string to writeenc- the encoding to use- Returns:
- a future completed with the result
-
sendFile
public Completable sendFile(String filename)
Tell the operating system to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.- Parameters:
filename- file name of the file to send- Returns:
- a future result of the send operation
-
rxSendFile
public Completable rxSendFile(String filename)
Tell the operating system to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.- Parameters:
filename- file name of the file to send- Returns:
- a future result of the send operation
-
sendFile
public Completable sendFile(String filename, long offset)
Tell the operating system to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.- Parameters:
filename- file name of the file to sendoffset- offset- Returns:
- a future result of the send operation
-
rxSendFile
public Completable rxSendFile(String filename, long offset)
Tell the operating system to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.- Parameters:
filename- file name of the file to sendoffset- offset- Returns:
- a future result of the send operation
-
sendFile
public Completable sendFile(String filename, long offset, long length)
Tell the operating system to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.- Parameters:
filename- file name of the file to sendoffset- offsetlength- length- Returns:
- a future result of the send operation
-
rxSendFile
public Completable rxSendFile(String filename, long offset, long length)
Tell the operating system to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.- Parameters:
filename- file name of the file to sendoffset- offsetlength- length- Returns:
- a future result of the send operation
-
remoteAddress
public SocketAddress remoteAddress()
- Returns:
- the remote address for this connection, possibly
null(e.g a server bound on a domain socket). IfuseProxyProtocolis set totrue, the address returned will be of the actual connecting client.
-
remoteAddress
public SocketAddress remoteAddress(boolean real)
- Parameters:
real-- Returns:
-
localAddress
public SocketAddress localAddress()
- Returns:
- the local address for this connection, possibly
null(e.g a server bound on a domain socket) IfuseProxyProtocolis set totrue, the address returned will be of the proxy.
-
localAddress
public SocketAddress localAddress(boolean real)
- Parameters:
real-- Returns:
-
end
public Completable end()
Callsclose()- Specified by:
endin interfaceWriteStream<Buffer>- Returns:
- a future completed with the result
-
rxEnd
public Completable rxEnd()
Callsclose()- Specified by:
rxEndin interfaceWriteStream<Buffer>- Returns:
- a future completed with the result
-
close
public Completable close()
Close the socket- Returns:
- a future completed with the result
-
rxClose
public Completable rxClose()
Close the socket- Returns:
- a future completed with the result
-
closeHandler
public NetSocket closeHandler(Handler<Void> handler)
Set ahandlernotified when the socket is closed- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
shutdownHandler
public NetSocket shutdownHandler(Handler<Void> handler)
Set ahandlernotified when the socket is shutdown: the client or server will close the connection within a certain amount of time. This gives the opportunity to thehandlerto close the socket gracefully before the socket is closed.- Parameters:
handler- the handler notified- Returns:
- a reference to this, so the API can be used fluently
-
upgradeToSsl
public Completable upgradeToSsl()
LikeupgradeToSsl()with the default SSL options, without indicating a server name, without an upgrade message.- Returns:
-
rxUpgradeToSsl
public Completable rxUpgradeToSsl()
LikeupgradeToSsl()with the default SSL options, without indicating a server name, without an upgrade message.- Returns:
-
upgradeToSsl
public Completable upgradeToSsl(Buffer msg)
LikeupgradeToSsl()with the default SSL options and without indicating a server name.- Parameters:
msg-- Returns:
-
rxUpgradeToSsl
public Completable rxUpgradeToSsl(Buffer msg)
LikeupgradeToSsl()with the default SSL options and without indicating a server name.- Parameters:
msg-- Returns:
-
upgradeToSsl
public Completable upgradeToSsl(String serverName)
LikeupgradeToSsl()with the default SSL options and without an update message.- Parameters:
serverName-- Returns:
-
rxUpgradeToSsl
public Completable rxUpgradeToSsl(String serverName)
LikeupgradeToSsl()with the default SSL options and without an update message.- Parameters:
serverName-- Returns:
-
upgradeToSsl
public Completable upgradeToSsl(String serverName, Buffer msg)
LikeupgradeToSsl()with the default SSL options.- Parameters:
serverName-msg-- Returns:
-
rxUpgradeToSsl
public Completable rxUpgradeToSsl(String serverName, Buffer msg)
LikeupgradeToSsl()with the default SSL options.- Parameters:
serverName-msg-- Returns:
-
upgradeToSsl
public Completable upgradeToSsl(SSLOptions sslOptions, String serverName)
LikeupgradeToSsl()without an upgrade message.- Parameters:
sslOptions-serverName-- Returns:
-
rxUpgradeToSsl
public Completable rxUpgradeToSsl(SSLOptions sslOptions, String serverName)
LikeupgradeToSsl()without an upgrade message.- Parameters:
sslOptions-serverName-- Returns:
-
upgradeToSsl
public Completable upgradeToSsl(SSLOptions sslOptions, Buffer msg)
LikeupgradeToSsl()without indicating a server name- Parameters:
sslOptions-msg-- Returns:
-
rxUpgradeToSsl
public Completable rxUpgradeToSsl(SSLOptions sslOptions, Buffer msg)
LikeupgradeToSsl()without indicating a server name- Parameters:
sslOptions-msg-- Returns:
-
upgradeToSsl
public Completable upgradeToSsl(SSLOptions sslOptions, String serverName, Buffer upgrade)
Upgrade the channel to use SSL/TLS, in other words proceeds to the TLS handshake.
The
upgrademessage will be sent after the socket is ready to proceed to the TLS handshake in order to avoid data races. In practice is usually send by a server when it sends a message to the client to proceed to the handshake, e.g.250 STARTTLSfor an SMTP server, it should benullon a clientThe server name is sent in the client handshake, it should be
nullon a server.Be aware that for this to work SSL must be configured.
- Parameters:
sslOptions- the SSL optionsserverName- the server nameupgrade- the upgrade message to send- Returns:
- a future completed when the connection has been upgraded to SSL
-
rxUpgradeToSsl
public Completable rxUpgradeToSsl(SSLOptions sslOptions, String serverName, Buffer upgrade)
Upgrade the channel to use SSL/TLS, in other words proceeds to the TLS handshake.
The
upgrademessage will be sent after the socket is ready to proceed to the TLS handshake in order to avoid data races. In practice is usually send by a server when it sends a message to the client to proceed to the handshake, e.g.250 STARTTLSfor an SMTP server, it should benullon a clientThe server name is sent in the client handshake, it should be
nullon a server.Be aware that for this to work SSL must be configured.
- Parameters:
sslOptions- the SSL optionsserverName- the server nameupgrade- the upgrade message to send- Returns:
- a future completed when the connection has been upgraded to SSL
-
upgradeToSsl
public Completable upgradeToSsl(SSLOptions sslOptions)
Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.- Parameters:
sslOptions- the SSL options- Returns:
- a future completed when the connection has been upgraded to SSL
-
rxUpgradeToSsl
public Completable rxUpgradeToSsl(SSLOptions sslOptions)
Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.- Parameters:
sslOptions- the SSL options- Returns:
- a future completed when the connection has been upgraded to SSL
-
isSsl
public boolean isSsl()
- Returns:
- true if this
NetSocketis encrypted via SSL/TLS.
-
indicatedServerName
public String indicatedServerName()
Returns the SNI server name presented during the SSL handshake by the client.- Returns:
- the indicated server name
-
applicationLayerProtocol
public String applicationLayerProtocol()
- Returns:
- the application-level protocol negotiated during the TLS handshake
-
sslSession
public SSLSession sslSession()
- Returns:
- SSLSession associated with the underlying socket. Returns null if connection is not SSL.
-
-