Interface NetSocket
-
- All Superinterfaces:
ReadStream<Buffer>,StreamBase,WriteStream<Buffer>
public interface NetSocket extends 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
ReadStreamandWriteStreamso it can be used withPipeto pipe data with flow control.- Author:
- Tim Fox
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description StringapplicationLayerProtocol()Future<Void>close()Close the socketNetSocketcloseHandler(Handler<Void> handler)Set ahandlernotified when the socket is closedNetSocketdrainHandler(Handler<Void> handler)Set a drain handler on the stream.Future<Void>end()Callsclose()NetSocketendHandler(Handler<Void> endHandler)Set an end handler.NetSocketexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.NetSocketfetch(long amount)Fetch the specifiedamountof elements.NetSockethandler(Handler<Buffer> handler)Set a data handler.StringindicatedServerName()Returns the SNI server name presented during the SSL handshake by the client.booleanisSsl()SocketAddresslocalAddress()SocketAddresslocalAddress(boolean real)NetSocketpause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.List<Certificate>peerCertificates()SocketAddressremoteAddress()SocketAddressremoteAddress(boolean real)NetSocketresume()Resume reading, and sets the buffer inflowingmode.default Future<Void>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.default Future<Void>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.Future<Void>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.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()default Future<Void>upgradeToSsl()LikeupgradeToSsl(SSLOptions, String, Buffer)with the default SSL options, without indicating a server name, without an upgrade message.default Future<Void>upgradeToSsl(Buffer msg)LikeupgradeToSsl(SSLOptions, String, Buffer)with the default SSL options and without indicating a server name.default Future<Void>upgradeToSsl(SSLOptions sslOptions)Upgrade channel to use SSL/TLS.default Future<Void>upgradeToSsl(SSLOptions sslOptions, Buffer msg)LikeupgradeToSsl(SSLOptions, String, Buffer)without indicating a server namedefault Future<Void>upgradeToSsl(SSLOptions sslOptions, String serverName)LikeupgradeToSsl(SSLOptions, String, Buffer)without an upgrade message.Future<Void>upgradeToSsl(SSLOptions sslOptions, String serverName, Buffer upgrade)Upgrade the channel to use SSL/TLS, in other words proceeds to the TLS handshake.default Future<Void>upgradeToSsl(String serverName)LikeupgradeToSsl(SSLOptions, String, Buffer)with the default SSL options and without an update message.default Future<Void>upgradeToSsl(String serverName, Buffer msg)LikeupgradeToSsl(SSLOptions, String, Buffer)with the default SSL options.Future<Void>write(String str)Write aStringto the connection, encoded in UTF-8.Future<Void>write(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.-
Methods inherited from interface io.vertx.core.streams.ReadStream
blockingStream, collect, pipe, pipeTo
-
Methods inherited from interface io.vertx.core.streams.WriteStream
end, write, writeQueueFull
-
-
-
-
Method Detail
-
exceptionHandler
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
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
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
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
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
NetSocket endHandler(Handler<Void> endHandler)
Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.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>- Returns:
- a reference to this, so the API can be used fluently
-
setWriteQueueMaxSize
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
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
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
NetClientOptions.setRegisterWriteHandler(boolean)orNetServerOptions.setRegisterWriteHandler(boolean).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
- See Also:
NetClientOptions.setRegisterWriteHandler(boolean),NetServerOptions.setRegisterWriteHandler(boolean)
-
write
Future<Void> write(String str)
Write aStringto the connection, encoded in UTF-8.- Parameters:
str- the string to write- Returns:
- a future result of the write
-
write
Future<Void> 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
-
sendFile
default Future<Void> 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
-
sendFile
default Future<Void> 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
-
sendFile
Future<Void> 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
-
remoteAddress
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
SocketAddress remoteAddress(boolean real)
-
localAddress
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
SocketAddress localAddress(boolean real)
-
end
Future<Void> end()
Callsclose()- Specified by:
endin interfaceWriteStream<Buffer>- Returns:
- a future completed with the result
-
closeHandler
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
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
default Future<Void> upgradeToSsl()
LikeupgradeToSsl(SSLOptions, String, Buffer)with the default SSL options, without indicating a server name, without an upgrade message.
-
upgradeToSsl
default Future<Void> upgradeToSsl(Buffer msg)
LikeupgradeToSsl(SSLOptions, String, Buffer)with the default SSL options and without indicating a server name.
-
upgradeToSsl
default Future<Void> upgradeToSsl(String serverName)
LikeupgradeToSsl(SSLOptions, String, Buffer)with the default SSL options and without an update message.
-
upgradeToSsl
default Future<Void> upgradeToSsl(String serverName, Buffer msg)
LikeupgradeToSsl(SSLOptions, String, Buffer)with the default SSL options.
-
upgradeToSsl
default Future<Void> upgradeToSsl(SSLOptions sslOptions, String serverName)
LikeupgradeToSsl(SSLOptions, String, Buffer)without an upgrade message.
-
upgradeToSsl
default Future<Void> upgradeToSsl(SSLOptions sslOptions, Buffer msg)
LikeupgradeToSsl(SSLOptions, String, Buffer)without indicating a server name
-
upgradeToSsl
Future<Void> 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
-
upgradeToSsl
default Future<Void> 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
-
isSsl
boolean isSsl()
- Returns:
- true if this
NetSocketis encrypted via SSL/TLS.
-
sslSession
SSLSession sslSession()
- Returns:
- SSLSession associated with the underlying socket. Returns null if connection is not SSL.
- See Also:
SSLSession
-
peerCertificates
List<Certificate> peerCertificates() throws SSLPeerUnverifiedException
- Returns:
- an ordered list of the peer certificates. Returns null if connection is not SSL.
- Throws:
SSLPeerUnverifiedException- SSL peer's identity has not been verified.- See Also:
SSLSession.getPeerCertificates(),sslSession()
-
indicatedServerName
String indicatedServerName()
Returns the SNI server name presented during the SSL handshake by the client.- Returns:
- the indicated server name
-
applicationLayerProtocol
String applicationLayerProtocol()
- Returns:
- the application-level protocol negotiated during the TLS handshake
-
-