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
Pump to pump data with flow control.
original non RX-ified interface using Vert.x codegen.| Modifier and Type | Field and Description |
|---|---|
static TypeArg<NetSocket> |
__TYPE_ARG |
| Constructor and Description |
|---|
NetSocket(io.vertx.core.net.NetSocket delegate) |
| Modifier and Type | Method and Description |
|---|---|
CompletionStage<Void> |
close()
Close the NetSocket and notify the
handler when the operation completes. |
NetSocket |
closeHandler(Consumer<Void> handler)
Set a handler that will be called when the NetSocket is closed
|
NetSocket |
drainHandler(Consumer<Void> handler)
Set a drain handler on the stream.
|
CompletionStage<Void> |
end()
|
CompletionStage<Void> |
end(Buffer data)
Same as but with an
handler called when the operation completes |
NetSocket |
endHandler(Consumer<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(Consumer<Throwable> handler)
Set an exception handler on the read stream.
|
NetSocket |
fetch(long amount)
Fetch the specified
amount of elements. |
io.vertx.core.net.NetSocket |
getDelegate() |
NetSocket |
handler(Consumer<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() |
static NetSocket |
newInstance(io.vertx.core.net.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 .
|
CompletionStage<Void> |
pipeTo(WriteStream<Buffer> dst)
Pipe this
ReadStream to the WriteStream. |
SocketAddress |
remoteAddress() |
NetSocket |
resume()
Resume reading, and sets the buffer in
flowing mode. |
CompletionStage<Void> |
sendFile(String filename)
Same as
sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or
a failure has occurred |
CompletionStage<Void> |
sendFile(String filename,
long offset)
Same as
sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or
a failure has occurred |
CompletionStage<Void> |
sendFile(String filename,
long offset,
long length)
Same as
sendFile(java.lang.String) 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() |
org.reactivestreams.Publisher<Buffer> |
toPublisher() |
org.eclipse.microprofile.reactive.streams.operators.PublisherBuilder<Buffer> |
toPublisherBuilder() |
String |
toString() |
NetSocket |
upgradeToSsl(Consumer<Void> handler)
Upgrade channel to use SSL/TLS.
|
NetSocket |
upgradeToSsl(String serverName,
Consumer<Void> handler)
Upgrade channel to use SSL/TLS.
|
CompletionStage<Void> |
write(Buffer message)
Like but with an
handler called when the message has been written
or failed to be written. |
CompletionStage<Void> |
write(String str)
Same as
write(java.lang.String) but with an handler called when the operation completes |
CompletionStage<Void> |
write(String str,
String enc)
Same as
write(java.lang.String) 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, waitnewInstance, newInstancenewInstance, newInstancenewInstancepublic io.vertx.core.net.NetSocket getDelegate()
getDelegate in interface ReadStream<Buffer>getDelegate in interface StreamBasegetDelegate in interface WriteStream<Buffer>public org.reactivestreams.Publisher<Buffer> toPublisher()
toPublisher in interface ReadStream<Buffer>public org.eclipse.microprofile.reactive.streams.operators.PublisherBuilder<Buffer> toPublisherBuilder()
public CompletionStage<Void> end(Buffer data)
handler called when the operation completesend 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>public Pipe<Buffer> pipe()
WriteStream.pipe in interface ReadStream<Buffer>public CompletionStage<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 NetSocket exceptionHandler(Consumer<Throwable> handler)
ReadStreamexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBaseexceptionHandler in interface WriteStream<Buffer>handler - the exception handlerpublic NetSocket handler(Consumer<Buffer> handler)
ReadStreamhandler in interface ReadStream<Buffer>public NetSocket 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>public NetSocket resume()
ReadStreamflowing mode.
If the ReadStream has been paused, reading will recommence on it.resume in interface ReadStream<Buffer>public NetSocket 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>public NetSocket endHandler(Consumer<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)
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
Pump to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket, the number of Message for a
MessageProducer, etc...setWriteQueueMaxSize in interface WriteStream<Buffer>maxSize - the max size of the write streampublic NetSocket drainHandler(Consumer<Void> handler)
WriteStreamPump 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 CompletionStage<Void> write(String str)
write(java.lang.String) but with an handler called when the operation completesstr - public CompletionStage<Void> write(String str, String enc)
write(java.lang.String) but with an handler called when the operation completesstr - enc - public CompletionStage<Void> write(Buffer message)
handler called when the message has been written
or failed to be written.write in interface WriteStream<Buffer>message - public CompletionStage<Void> sendFile(String filename)
sendFile(java.lang.String) 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 CompletionStage<Void> sendFile(String filename, long offset)
sendFile(java.lang.String) 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 CompletionStage<Void> sendFile(String filename, long offset, long length)
sendFile(java.lang.String) 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()
public SocketAddress localAddress()
public CompletionStage<Void> end()
end in interface WriteStream<Buffer>public CompletionStage<Void> close()
handler when the operation completes.public NetSocket closeHandler(Consumer<Void> handler)
handler - the handlerpublic NetSocket upgradeToSsl(Consumer<Void> handler)
handler - the handler will be notified when it's upgradedpublic NetSocket upgradeToSsl(String serverName, Consumer<Void> handler)
serverName - the server namehandler - the handler will be notified when it's upgradedpublic boolean isSsl()
NetSocket is encrypted via SSL/TLS.public String indicatedServerName()
public SSLSession sslSession()
public static NetSocket newInstance(io.vertx.core.net.NetSocket arg)
Copyright © 2019 SmallRye. All rights reserved.