public class NetSocket extends Object implements ReadStream<Buffer>, WriteStream<Buffer>
Instances of this class are created on the client side by an NetClient
when a connection to a server is made, or on the server side by a NetServer
when a server accepts a connection.
It implements both and so it can be used with
Pipe
to pipe data with flow control.
original
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<NetSocket> |
__TYPE_ARG |
Constructor and Description |
---|
NetSocket(NetSocket delegate) |
NetSocket(Object delegate) |
Modifier and Type | Method and Description |
---|---|
String |
applicationLayerProtocol() |
void |
close()
Close the NetSocket and notify the
handler when the operation completes. |
void |
close(Handler<AsyncResult<Void>> handler)
Close the NetSocket and notify the
handler when the operation completes. |
NetSocket |
closeHandler(Handler<Void> handler)
Set a handler that will be called when the NetSocket is closed
|
NetSocket |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
void |
end()
|
void |
end(Buffer data)
Same as but with an
handler called when the operation completes |
void |
end(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as but with an
handler called when the operation completes |
void |
end(Handler<AsyncResult<Void>> handler)
|
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.
|
boolean |
equals(Object o) |
NetSocket |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
NetSocket |
fetch(long amount)
Fetch the specified
amount of elements. |
NetSocket |
getDelegate() |
NetSocket |
handler(Handler<Buffer> handler)
Set a data handler.
|
int |
hashCode() |
String |
indicatedServerName()
Returns the SNI server name presented during the SSL handshake by the client.
|
boolean |
isSsl() |
SocketAddress |
localAddress() |
SocketAddress |
localAddress(boolean real)
|
static NetSocket |
newInstance(NetSocket arg) |
NetSocket |
pause()
Pause the
ReadStream , it sets the buffer in fetch mode and clears the actual demand. |
Pipe<Buffer> |
pipe()
Pause this stream and return a to transfer the elements of this stream to a destination .
|
void |
pipeTo(WriteStream<Buffer> dst)
Pipe this
ReadStream to the WriteStream . |
void |
pipeTo(WriteStream<Buffer> dst,
Handler<AsyncResult<Void>> handler)
Pipe this
ReadStream to the WriteStream . |
SocketAddress |
remoteAddress() |
SocketAddress |
remoteAddress(boolean real)
|
NetSocket |
resume()
Resume reading, and sets the buffer in
flowing mode. |
Single<Void> |
rxClose()
Close the NetSocket and notify the
handler when the operation completes. |
Single<Void> |
rxEnd()
|
Single<Void> |
rxEnd(Buffer data)
Same as but with an
handler called when the operation completes |
Single<Void> |
rxPipeTo(WriteStream<Buffer> dst)
Pipe this
ReadStream to the WriteStream . |
Single<Void> |
rxSendFile(String filename)
Same as
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but also takes a handler that will be called when the send has completed or
a failure has occurred |
Single<Void> |
rxSendFile(String filename,
long offset)
Same as
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but also takes a handler that will be called when the send has completed or
a failure has occurred |
Single<Void> |
rxSendFile(String filename,
long offset,
long length)
Same as
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but also takes a handler that will be called when the send has completed or
a failure has occurred |
Single<Void> |
rxUpgradeToSsl()
Upgrade channel to use SSL/TLS.
|
Single<Void> |
rxUpgradeToSsl(String serverName)
Upgrade channel to use SSL/TLS.
|
Single<Void> |
rxWrite(Buffer message)
Like
WriteStream.write(T, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the message has been written
or failed to be written. |
Single<Void> |
rxWrite(String str)
Same as
write(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
Single<Void> |
rxWrite(String str,
String enc)
Same as
write(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
NetSocket |
sendFile(String filename)
Same as
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but also takes a handler that will be called when the send has completed or
a failure has occurred |
NetSocket |
sendFile(String filename,
Handler<AsyncResult<Void>> resultHandler)
Same as
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but also takes a handler that will be called when the send has completed or
a failure has occurred |
NetSocket |
sendFile(String filename,
long offset)
Same as
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but also takes a handler that will be called when the send has completed or
a failure has occurred |
NetSocket |
sendFile(String filename,
long offset,
Handler<AsyncResult<Void>> resultHandler)
Same as
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but also takes a handler that will be called when the send has completed or
a failure has occurred |
NetSocket |
sendFile(String filename,
long offset,
long length)
Same as
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but also takes a handler that will be called when the send has completed or
a failure has occurred |
NetSocket |
sendFile(String filename,
long offset,
long length,
Handler<AsyncResult<Void>> resultHandler)
Same as
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but also takes a handler that will be called when the send has completed or
a failure has occurred |
NetSocket |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize . |
SSLSession |
sslSession() |
Observable<Buffer> |
toObservable() |
String |
toString() |
WriteStreamSubscriber<Buffer> |
toSubscriber() |
NetSocket |
upgradeToSsl()
Upgrade channel to use SSL/TLS.
|
NetSocket |
upgradeToSsl(Handler<AsyncResult<Void>> handler)
Upgrade channel to use SSL/TLS.
|
NetSocket |
upgradeToSsl(String serverName)
Upgrade channel to use SSL/TLS.
|
NetSocket |
upgradeToSsl(String serverName,
Handler<AsyncResult<Void>> handler)
Upgrade channel to use SSL/TLS.
|
void |
write(Buffer message)
Like
WriteStream.write(T, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the message has been written
or failed to be written. |
void |
write(Buffer message,
Handler<AsyncResult<Void>> handler)
Like
WriteStream.write(T, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the message has been written
or failed to be written. |
void |
write(String str)
Same as
write(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
write(String str,
Handler<AsyncResult<Void>> handler)
Same as
write(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
write(String str,
String enc)
Same as
write(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
write(String str,
String enc,
Handler<AsyncResult<Void>> handler)
Same as
write(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
String |
writeHandlerID()
When a
NetSocket is created it automatically registers an event handler with the event bus, the ID of that
handler is given by writeHandlerID . |
boolean |
writeQueueFull()
This will return
true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int) |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
newInstance, newInstance
newInstance, newInstance
newInstance
public static final io.vertx.lang.rx.TypeArg<NetSocket> __TYPE_ARG
public NetSocket(NetSocket delegate)
public NetSocket(Object delegate)
public NetSocket getDelegate()
getDelegate
in interface ReadStream<Buffer>
getDelegate
in interface StreamBase
getDelegate
in interface WriteStream<Buffer>
public Observable<Buffer> toObservable()
toObservable
in interface ReadStream<Buffer>
public WriteStreamSubscriber<Buffer> toSubscriber()
public Pipe<Buffer> pipe()
WriteStream
.pipe
in interface ReadStream<Buffer>
public void pipeTo(WriteStream<Buffer> dst, Handler<AsyncResult<Void>> handler)
ReadStream
to the WriteStream
.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler
will be
called with the result.
pipeTo
in interface ReadStream<Buffer>
dst
- the destination write streamhandler
- public void pipeTo(WriteStream<Buffer> dst)
ReadStream
to the WriteStream
.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler
will be
called with the result.
pipeTo
in interface ReadStream<Buffer>
dst
- the destination write streampublic Single<Void> rxPipeTo(WriteStream<Buffer> dst)
ReadStream
to the WriteStream
.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler
will be
called with the result.
rxPipeTo
in interface ReadStream<Buffer>
dst
- the destination write streampublic void end(Buffer data, Handler<AsyncResult<Void>> handler)
handler
called when the operation completesend
in interface WriteStream<Buffer>
data
- handler
- public void end(Buffer data)
handler
called when the operation completesend
in interface WriteStream<Buffer>
data
- public Single<Void> rxEnd(Buffer data)
handler
called when the operation completesrxEnd
in interface WriteStream<Buffer>
data
- public boolean writeQueueFull()
true
if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)
writeQueueFull
in interface WriteStream<Buffer>
true
if write queue is fullpublic NetSocket exceptionHandler(Handler<Throwable> handler)
ReadStream
exceptionHandler
in interface ReadStream<Buffer>
exceptionHandler
in interface StreamBase
exceptionHandler
in interface WriteStream<Buffer>
handler
- the exception handlerpublic NetSocket handler(Handler<Buffer> handler)
ReadStream
handler
in interface ReadStream<Buffer>
public NetSocket pause()
ReadStream
ReadStream
, 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>
public NetSocket resume()
ReadStream
flowing
mode.
If the ReadStream
has been paused, reading will recommence on it.resume
in interface ReadStream<Buffer>
public NetSocket fetch(long amount)
ReadStream
amount
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>
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.
endHandler
in interface ReadStream<Buffer>
endHandler
- public NetSocket setWriteQueueMaxSize(int maxSize)
WriteStream
maxSize
. 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 streampublic NetSocket drainHandler(Handler<Void> handler)
WriteStream
Pipe
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 handlerpublic String writeHandlerID()
NetSocket
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 connection. This allows you to write data to other connections which are owned by different event loops.
public void write(String str, Handler<AsyncResult<Void>> handler)
write(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesstr
- handler
- public void write(String str)
write(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesstr
- public Single<Void> rxWrite(String str)
write(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesstr
- public void write(String str, String enc, Handler<AsyncResult<Void>> handler)
write(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesstr
- enc
- handler
- public void write(String str, String enc)
write(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesstr
- enc
- public Single<Void> rxWrite(String str, String enc)
write(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesstr
- enc
- public void write(Buffer message, Handler<AsyncResult<Void>> handler)
WriteStream.write(T, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the message has been written
or failed to be written.write
in interface WriteStream<Buffer>
message
- handler
- public void write(Buffer message)
WriteStream.write(T, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the message has been written
or failed to be written.write
in interface WriteStream<Buffer>
message
- public Single<Void> rxWrite(Buffer message)
WriteStream.write(T, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the message has been written
or failed to be written.rxWrite
in interface WriteStream<Buffer>
message
- public NetSocket sendFile(String filename, Handler<AsyncResult<Void>> resultHandler)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but also takes a handler that will be called when the send has completed or
a failure has occurredfilename
- file name of the file to sendresultHandler
- handlerpublic NetSocket sendFile(String filename)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but also takes a handler that will be called when the send has completed or
a failure has occurredfilename
- file name of the file to sendpublic Single<Void> rxSendFile(String filename)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but also takes a handler that will be called when the send has completed or
a failure has occurredfilename
- file name of the file to sendpublic NetSocket sendFile(String filename, long offset, Handler<AsyncResult<Void>> resultHandler)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but also takes a handler that will be called when the send has completed or
a failure has occurredfilename
- file name of the file to sendoffset
- offsetresultHandler
- handlerpublic NetSocket sendFile(String filename, long offset)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but also takes a handler that will be called when the send has completed or
a failure has occurredfilename
- file name of the file to sendoffset
- offsetpublic Single<Void> rxSendFile(String filename, long offset)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but also takes a handler that will be called when the send has completed or
a failure has occurredfilename
- file name of the file to sendoffset
- offsetpublic NetSocket sendFile(String filename, long offset, long length, Handler<AsyncResult<Void>> resultHandler)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but also takes a handler that will be called when the send has completed or
a failure has occurredfilename
- file name of the file to sendoffset
- offsetlength
- lengthresultHandler
- handlerpublic NetSocket sendFile(String filename, long offset, long length)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but also takes a handler that will be called when the send has completed or
a failure has occurredfilename
- file name of the file to sendoffset
- offsetlength
- lengthpublic Single<Void> rxSendFile(String filename, long offset, long length)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but also takes a handler that will be called when the send has completed or
a failure has occurredfilename
- file name of the file to sendoffset
- offsetlength
- lengthpublic SocketAddress remoteAddress()
null
(e.g a server bound on a domain socket). If useProxyProtocol
is set to true
, the address returned will be of the actual connecting client.public SocketAddress remoteAddress(boolean real)
real
- public SocketAddress localAddress()
null
(e.g a server bound on a domain socket) If useProxyProtocol
is set to true
, the address returned will be of the proxy.public SocketAddress localAddress(boolean real)
real
- public void end(Handler<AsyncResult<Void>> handler)
end
in interface WriteStream<Buffer>
handler
- public void end()
end
in interface WriteStream<Buffer>
public Single<Void> rxEnd()
rxEnd
in interface WriteStream<Buffer>
public void close(Handler<AsyncResult<Void>> handler)
handler
when the operation completes.handler
- public void close()
handler
when the operation completes.public Single<Void> rxClose()
handler
when the operation completes.public NetSocket closeHandler(Handler<Void> handler)
handler
- the handlerpublic NetSocket upgradeToSsl(Handler<AsyncResult<Void>> handler)
handler
- the handler will be notified when it's upgradedpublic NetSocket upgradeToSsl()
public Single<Void> rxUpgradeToSsl()
public NetSocket upgradeToSsl(String serverName, Handler<AsyncResult<Void>> handler)
serverName
- the server namehandler
- the handler will be notified when it's upgradedpublic NetSocket upgradeToSsl(String serverName)
serverName
- the server namepublic Single<Void> rxUpgradeToSsl(String serverName)
serverName
- the server namepublic boolean isSsl()
NetSocket
is encrypted via SSL/TLS.public String indicatedServerName()
public String applicationLayerProtocol()
public SSLSession sslSession()
Copyright © 2023 Eclipse. All rights reserved.