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
Pump
to pump data with flow control.
Modifier and Type | Method and Description |
---|---|
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.
|
void |
end()
Calls
close() |
void |
end(Handler<AsyncResult<Void>> handler)
Calls
end(Handler) |
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() |
NetSocket |
pause()
Pause the
ReadStream , it sets the buffer in fetch mode and clears the actual demand. |
X509Certificate[] |
peerCertificateChain()
Note: Java SE 5+ recommends to use javax.net.ssl.SSLSession#getPeerCertificates() instead of
of javax.net.ssl.SSLSession#getPeerCertificateChain() which this method is based on.
|
SocketAddress |
remoteAddress() |
NetSocket |
resume()
Resume reading, and sets the buffer in
flowing mode. |
default NetSocket |
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 NetSocket |
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 |
NetSocket |
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() |
NetSocket |
upgradeToSsl(Handler<Void> handler)
Upgrade channel to use SSL/TLS.
|
NetSocket |
upgradeToSsl(String serverName,
Handler<Void> handler)
Upgrade channel to use SSL/TLS.
|
NetSocket |
write(Buffer data)
Write some data to the stream.
|
NetSocket |
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. |
NetSocket |
write(String str)
Write a
String to the connection, encoded in UTF-8. |
NetSocket |
write(String str,
Handler<AsyncResult<Void>> handler)
Same as
write(String) but with an handler called when the operation completes |
NetSocket |
write(String str,
String enc)
Write a
String to the connection, encoded using the encoding enc . |
NetSocket |
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, 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 write(Buffer data)
WriteStream
WriteStream.writeQueueFull()
method before writing. This is done automatically if using a Pump
.write
in interface WriteStream<Buffer>
data
- the data to writeNetSocket 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
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 streamNetSocket drainHandler(Handler<Void> handler)
WriteStream
Pump
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.
NetSocket write(String str, Handler<AsyncResult<Void>> handler)
write(String)
but with an handler
called when the operation completesNetSocket write(String str)
String
to the connection, encoded in UTF-8.str
- the string to writeNetSocket write(String str, String enc, Handler<AsyncResult<Void>> handler)
write(String, String)
but with an handler
called when the operation completesNetSocket write(String str, String enc)
String
to the connection, encoded using the encoding enc
.str
- the string to writeenc
- the encoding to useNetSocket 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 NetSocket 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 NetSocket 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
- offsetNetSocket 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)SocketAddress localAddress()
null
(e.g a server bound on a domain socket)void end()
close()
end
in interface WriteStream<Buffer>
void end(Handler<AsyncResult<Void>> handler)
end(Handler)
end
in interface WriteStream<Buffer>
void close()
void close(Handler<AsyncResult<Void>> handler)
handler
when the operation completes.NetSocket closeHandler(Handler<Void> handler)
handler
- the handlerNetSocket upgradeToSsl(Handler<Void> handler)
handler
- the handler will be notified when it's upgradedNetSocket upgradeToSsl(String serverName, Handler<Void> handler)
serverName
- the server namehandler
- the handler will be notified when it's upgradedboolean isSsl()
NetSocket
is encrypted via SSL/TLS.SSLSession sslSession()
SSLSession
X509Certificate[] peerCertificateChain() throws SSLPeerUnverifiedException
sslSession()
to
access that method.SSLPeerUnverifiedException
- SSL peer's identity has not been verified.SSLSession.getPeerCertificateChain()
,
sslSession()
String indicatedServerName()
Copyright © 2023 Eclipse. All rights reserved.