public interface NetSocket extends 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 ReadStream
and WriteStream
so it can be used with
Pipe
to pipe data with flow control.
Modifier and Type | Method and Description |
---|---|
String |
applicationLayerProtocol() |
Future<Void> |
close()
Close the NetSocket
|
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.
|
Future<Void> |
end()
Calls
close() |
void |
end(Handler<AsyncResult<Void>> handler)
Calls
end() . |
NetSocket |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
NetSocket |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
NetSocket |
fetch(long amount)
Fetch the specified
amount of elements. |
NetSocket |
handler(Handler<Buffer> handler)
Set a data handler.
|
String |
indicatedServerName()
Returns the SNI server name presented during the SSL handshake by the client.
|
boolean |
isSsl() |
SocketAddress |
localAddress() |
SocketAddress |
localAddress(boolean real)
|
NetSocket |
pause()
Pause the
ReadStream , it sets the buffer in fetch mode and clears the actual demand. |
X509Certificate[] |
peerCertificateChain()
Deprecated.
instead use
peerCertificates() or sslSession() |
List<Certificate> |
peerCertificates() |
SocketAddress |
remoteAddress() |
SocketAddress |
remoteAddress(boolean real)
|
NetSocket |
resume()
Resume reading, and sets the buffer in
flowing mode. |
default Future<Void> |
sendFile(String filename)
Tell the operating system to stream a file as specified by
filename directly from disk to the outgoing connection,
bypassing userspace altogether (where supported by the underlying operating system. |
default NetSocket |
sendFile(String filename,
Handler<AsyncResult<Void>> resultHandler)
Same as
sendFile(String) but also takes a handler that will be called when the send has completed or
a failure has occurred |
default Future<Void> |
sendFile(String filename,
long offset)
Tell the operating system to stream a file as specified by
filename directly from disk to the outgoing connection,
bypassing userspace altogether (where supported by the underlying operating system. |
default NetSocket |
sendFile(String filename,
long offset,
Handler<AsyncResult<Void>> resultHandler)
Same as
sendFile(String, long) but also takes a handler that will be called when the send has completed or
a failure has occurred |
Future<Void> |
sendFile(String filename,
long offset,
long length)
Tell the operating system to stream a file as specified by
filename directly from disk to the outgoing connection,
bypassing userspace altogether (where supported by the underlying operating system. |
NetSocket |
sendFile(String filename,
long offset,
long length,
Handler<AsyncResult<Void>> resultHandler)
Same as
sendFile(String, long, long) 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() |
Future<Void> |
upgradeToSsl()
Like
upgradeToSsl(Handler) but returns a Future of the asynchronous result |
NetSocket |
upgradeToSsl(Handler<AsyncResult<Void>> handler)
Upgrade channel to use SSL/TLS.
|
Future<Void> |
upgradeToSsl(String serverName)
Like
upgradeToSsl(String, Handler) but returns a Future of the asynchronous result |
NetSocket |
upgradeToSsl(String serverName,
Handler<AsyncResult<Void>> handler)
Upgrade channel to use SSL/TLS.
|
void |
write(Buffer message,
Handler<AsyncResult<Void>> handler)
Like
WriteStream.write(Object) but with an handler called when the message has been written
or failed to be written. |
Future<Void> |
write(String str)
Write a
String to the connection, encoded in UTF-8. |
void |
write(String str,
Handler<AsyncResult<Void>> handler)
Same as
write(String) but with an handler called when the operation completes |
Future<Void> |
write(String str,
String enc)
Write a
String to the connection, encoded using the encoding enc . |
void |
write(String str,
String enc,
Handler<AsyncResult<Void>> handler)
Same as
write(String, 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 . |
pipe, pipeTo, pipeTo
end, end, write, writeQueueFull
NetSocket exceptionHandler(Handler<Throwable> handler)
ReadStream
exceptionHandler
in interface ReadStream<Buffer>
exceptionHandler
in interface StreamBase
exceptionHandler
in interface WriteStream<Buffer>
handler
- the exception handlerNetSocket handler(Handler<Buffer> handler)
ReadStream
handler
in interface ReadStream<Buffer>
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>
NetSocket resume()
ReadStream
flowing
mode.
If the ReadStream
has been paused, reading will recommence on it.resume
in interface ReadStream<Buffer>
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>
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>
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 streamNetSocket 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 handlerString 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.
void write(String str, Handler<AsyncResult<Void>> handler)
write(String)
but with an handler
called when the operation completesFuture<Void> write(String str)
String
to the connection, encoded in UTF-8.str
- the string to writevoid write(String str, String enc, Handler<AsyncResult<Void>> handler)
write(String, String)
but with an handler
called when the operation completesFuture<Void> write(String str, String enc)
String
to the connection, encoded using the encoding enc
.str
- the string to writeenc
- the encoding to usevoid write(Buffer message, Handler<AsyncResult<Void>> handler)
WriteStream.write(Object)
but with an handler
called when the message has been written
or failed to be written.write
in interface WriteStream<Buffer>
default Future<Void> sendFile(String filename)
filename
directly 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.filename
- file name of the file to senddefault Future<Void> sendFile(String filename, long offset)
filename
directly 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.filename
- file name of the file to sendoffset
- offsetFuture<Void> sendFile(String filename, long offset, long length)
filename
directly 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.filename
- file name of the file to sendoffset
- offsetlength
- lengthdefault NetSocket sendFile(String filename, Handler<AsyncResult<Void>> resultHandler)
sendFile(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 sendresultHandler
- handlerdefault NetSocket sendFile(String filename, long offset, Handler<AsyncResult<Void>> resultHandler)
sendFile(String, long)
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
- handlerNetSocket sendFile(String filename, long offset, long length, Handler<AsyncResult<Void>> resultHandler)
sendFile(String, long, long)
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
- handlerSocketAddress 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.SocketAddress remoteAddress(boolean real)
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.SocketAddress localAddress(boolean real)
Future<Void> end()
close()
end
in interface WriteStream<Buffer>
void end(Handler<AsyncResult<Void>> handler)
end()
.end
in interface WriteStream<Buffer>
void close(Handler<AsyncResult<Void>> handler)
handler
when the operation completes.NetSocket closeHandler(Handler<Void> handler)
handler
- the handlerNetSocket upgradeToSsl(Handler<AsyncResult<Void>> handler)
handler
- the handler will be notified when it's upgradedFuture<Void> upgradeToSsl()
upgradeToSsl(Handler)
but returns a Future
of the asynchronous resultNetSocket upgradeToSsl(String serverName, Handler<AsyncResult<Void>> handler)
serverName
- the server namehandler
- the handler will be notified when it's upgradedFuture<Void> upgradeToSsl(String serverName)
upgradeToSsl(String, Handler)
but returns a Future
of the asynchronous resultboolean isSsl()
NetSocket
is encrypted via SSL/TLS.SSLSession sslSession()
SSLSession
@Deprecated X509Certificate[] peerCertificateChain() throws SSLPeerUnverifiedException
peerCertificates()
or sslSession()
SSLPeerUnverifiedException
- SSL peer's identity has not been verified.SSLSession.getPeerCertificateChain()
,
sslSession()
List<Certificate> peerCertificates() throws SSLPeerUnverifiedException
SSLPeerUnverifiedException
- SSL peer's identity has not been verified.SSLSession.getPeerCertificateChain()
,
sslSession()
String indicatedServerName()
String applicationLayerProtocol()
Copyright © 2023 Eclipse. All rights reserved.