pack-priv Class HttpNetSocket

public String applicationLayerProtocol()

Implements io.vertx.core.net.NetSocket.applicationLayerProtocol.

Returns:String

Doc from io.vertx.core.net.NetSocket.applicationLayerProtocol.

the application-level protocol negotiated during the TLS handshake

Annotations

@Override

close	back to summary
public Future<Void> close() Implements io.vertx.core.net.NetSocket.close. Doc from io.vertx.core.net.NetSocket.close. Close the NetSocket Returns:Future<Void> a future completed with the result Annotations @Override

public Future<Void> close()

Implements io.vertx.core.net.NetSocket.close.

Doc from io.vertx.core.net.NetSocket.close.

Close the NetSocket

Returns:Future<Void>

a future completed with the result

Annotations

@Override

close back to summary

close	back to summary
public void close(Handler<AsyncResult<Void>> handler) Implements io.vertx.core.net.NetSocket.close. Doc from io.vertx.core.net.NetSocket.close. Close the NetSocket and notify the `handler` when the operation completes. Annotations @Override

public void close(Handler<AsyncResult<Void>> handler)

Implements io.vertx.core.net.NetSocket.close.

Doc from io.vertx.core.net.NetSocket.close.

Close the NetSocket and notify the handler when the operation completes.

Annotations

@Override

closeHandler	back to summary
public NetSocket closeHandler(@Nullable Handler<Void> handler) Annotations @Override

closeHandler	back to summary
pack-priv Handler<Void> closeHandler()

drainHandler	back to summary
public NetSocket drainHandler(Handler<Void> handler) Implements io.vertx.core.net.NetSocket.drainHandler. Annotations @Override

drainHandler

public NetSocket drainHandler(Handler<Void> handler)

Implements io.vertx.core.net.NetSocket.drainHandler.

Annotations

@Override

end back to summary

end	back to summary
public Future<Void> end(Buffer data) Overrides default io.vertx.core.streams.WriteStream.end. Doc from io.vertx.core.streams.WriteStream.end. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Same as `end()` but writes some data to the stream before ending. Parameters data:Buffer the data to write Returns:Future<Void> a future completed with the result Annotations @Override

public Future<Void> end(Buffer data)

Overrides default io.vertx.core.streams.WriteStream.end.

Doc from io.vertx.core.streams.WriteStream.end.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Same as end() but writes some data to the stream before ending.

Parameters

data:Buffer: the data to write

Returns:Future<Void>

a future completed with the result

Annotations

@Override

end back to summary

end	back to summary
public void end(Buffer buffer, Handler<AsyncResult<Void>> handler) Overrides default io.vertx.core.streams.WriteStream.end. Doc from io.vertx.core.streams.WriteStream.end. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Same as `end(T)` but with an `handler` called when the operation completes Annotations @Override

public void end(Buffer buffer, Handler<AsyncResult<Void>> handler)

Overrides default io.vertx.core.streams.WriteStream.end.

Doc from io.vertx.core.streams.WriteStream.end.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Same as end(T) but with an handler called when the operation completes

Annotations

@Override

end back to summary

end	back to summary
public Future<Void> end() Implements io.vertx.core.net.NetSocket.end. Doc from io.vertx.core.net.NetSocket.end. Calls `close()` Returns:Future<Void> a future completed with the result Annotations @Override

public Future<Void> end()

Implements io.vertx.core.net.NetSocket.end.

Doc from io.vertx.core.net.NetSocket.end.

Calls close()

Returns:Future<Void>

a future completed with the result

Annotations

@Override

end back to summary

end	back to summary
public void end(Handler<AsyncResult<Void>> handler) Implements io.vertx.core.net.NetSocket.end. Doc from io.vertx.core.net.NetSocket.end. Calls `end()`. Annotations @Override

public void end(Handler<AsyncResult<Void>> handler)

Implements io.vertx.core.net.NetSocket.end.

Doc from io.vertx.core.net.NetSocket.end.

Calls end().

Annotations

@Override

endHandler	back to summary
public synchronized NetSocket endHandler(Handler<Void> handler) Implements io.vertx.core.net.NetSocket.endHandler. Doc from io.vertx.core.net.NetSocket.endHandler. This handler might be called after the close handler when the socket is paused and there are still buffers to deliver. Annotations @Override

endHandler

public synchronized NetSocket endHandler(Handler<Void> handler)

Implements io.vertx.core.net.NetSocket.endHandler.

Doc from io.vertx.core.net.NetSocket.endHandler.

This handler might be called after the close handler when the socket is paused and there are still buffers to deliver.

Annotations

@Override

endHandler	back to summary
pack-priv synchronized Handler<Void> endHandler()

exceptionHandler	back to summary
public synchronized NetSocket exceptionHandler(Handler<Throwable> handler) Implements io.vertx.core.net.NetSocket.exceptionHandler. Annotations @Override

exceptionHandler

public synchronized NetSocket exceptionHandler(Handler<Throwable> handler)

Implements io.vertx.core.net.NetSocket.exceptionHandler.

Annotations

@Override

exceptionHandler	back to summary
pack-priv synchronized Handler<Throwable> exceptionHandler()

fetch back to summary

fetch	back to summary
public NetSocket fetch(long amount) Implements io.vertx.core.net.NetSocket.fetch. Doc from io.vertx.core.streams.ReadStream.fetch. Fetch the specified `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. Returns:NetSocket a reference to this, so the API can be used fluently Annotations @Override

public NetSocket fetch(long amount)

Implements io.vertx.core.net.NetSocket.fetch.

Doc from io.vertx.core.streams.ReadStream.fetch.

Fetch the specified 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.

Returns:NetSocket

a reference to this, so the API can be used fluently

Annotations

@Override

handleData	back to summary
private void handleData(Buffer buf) References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

handleEnd	back to summary
private void handleEnd(Void v)

handleException	back to summary
private void handleException(Throwable cause)

handler	back to summary
public synchronized NetSocket handler(Handler<Buffer> handler) Implements io.vertx.core.net.NetSocket.handler. Annotations @Override

handler

public synchronized NetSocket handler(Handler<Buffer> handler)

Implements io.vertx.core.net.NetSocket.handler.

Annotations

@Override

handler	back to summary
pack-priv synchronized Handler<Buffer> handler()

indicatedServerName	back to summary
public String indicatedServerName() Implements io.vertx.core.net.NetSocket.indicatedServerName. Doc from io.vertx.core.net.NetSocket.indicatedServerName. Returns the SNI server name presented during the SSL handshake by the client. Returns:String the indicated server name Annotations @Override

indicatedServerName

SSLPeerUnverifiedException:

public String indicatedServerName()

Implements io.vertx.core.net.NetSocket.indicatedServerName.

Doc from io.vertx.core.net.NetSocket.indicatedServerName.

Returns the SNI server name presented during the SSL handshake by the client.

Returns:String

the indicated server name

Annotations

@Override

isSsl back to summary

isSsl	back to summary
public boolean isSsl() Implements io.vertx.core.net.NetSocket.isSsl. Returns:boolean Doc from io.vertx.core.net.NetSocket.isSsl. true if this `io.vertx.core.net.NetSocket` is encrypted via SSL/TLS. Annotations @Override

public boolean isSsl()

Implements io.vertx.core.net.NetSocket.isSsl.

Returns:boolean

Doc from io.vertx.core.net.NetSocket.isSsl.

true if this io.vertx.core.net.NetSocket is encrypted via SSL/TLS.

Annotations

@Override

localAddress back to summary

localAddress	back to summary
public SocketAddress localAddress() Implements io.vertx.core.net.NetSocket.localAddress. Returns:SocketAddress Doc from io.vertx.core.net.NetSocket.localAddress. the local address for this connection, possibly `null` (e.g a server bound on a domain socket) If `useProxyProtocol` is set to `true`, the address returned will be of the proxy. Annotations @Override

public SocketAddress localAddress()

Implements io.vertx.core.net.NetSocket.localAddress.

Returns:SocketAddress

Doc from io.vertx.core.net.NetSocket.localAddress.

the local address for this connection, possibly null (e.g a server bound on a domain socket) If useProxyProtocol is set to true, the address returned will be of the proxy.

Annotations

@Override

localAddress back to summary

localAddress	back to summary
public SocketAddress localAddress(boolean real) Implements io.vertx.core.net.NetSocket.localAddress. Doc from io.vertx.core.net.NetSocket.localAddress. Like `localAddress()` ()} but returns the server local address when `real` is `true` Annotations @Override

public SocketAddress localAddress(boolean real)

Implements io.vertx.core.net.NetSocket.localAddress.

Doc from io.vertx.core.net.NetSocket.localAddress.

Like localAddress() ()} but returns the server local address when real is true

Annotations

@Override

netSocket	back to summary
pack-priv static HttpNetSocket netSocket(ConnectionBase conn, ContextInternal context, ReadStream<Buffer> readStream, WriteStream<Buffer> writeStream)

pause back to summary

pause	back to summary
public NetSocket pause() Implements io.vertx.core.net.NetSocket.pause. Doc from io.vertx.core.streams.ReadStream.pause. Pause the `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`. Returns:NetSocket a reference to this, so the API can be used fluently Annotations @Override

public NetSocket pause()

Implements io.vertx.core.net.NetSocket.pause.

Doc from io.vertx.core.streams.ReadStream.pause.

Pause the 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.

Returns:NetSocket

a reference to this, so the API can be used fluently

Annotations

@Override

peerCertificateChain back to summary

peerCertificateChain	back to summary
public X509Certificate[] peerCertificateChain() throws SSLPeerUnverifiedException Implements io.vertx.core.net.NetSocket.peerCertificateChain. References Deprecated `X509Certificate` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Returns:X509Certificate[] Doc from io.vertx.core.net.NetSocket.peerCertificateChain. an ordered array of the peer certificates. Returns null if connection is not SSL. Annotations @Override Exceptions SSLPeerUnverifiedException: Doc from io.vertx.core.net.NetSocket.peerCertificateChain. SSL peer's identity has not been verified.

public X509Certificate[] peerCertificateChain() throws SSLPeerUnverifiedException

Implements io.vertx.core.net.NetSocket.peerCertificateChain.

References Deprecated

X509Certificate is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Returns:X509Certificate[]

Doc from io.vertx.core.net.NetSocket.peerCertificateChain.

an ordered array of the peer certificates. Returns null if connection is not SSL.

Annotations

@Override

Exceptions

Doc from io.vertx.core.net.NetSocket.peerCertificateChain.

SSL peer's identity has not been verified.

peerCertificates	back to summary
public List<Certificate> peerCertificates() throws SSLPeerUnverifiedException Implements io.vertx.core.net.NetSocket.peerCertificates. Returns:List<Certificate> Doc from io.vertx.core.net.NetSocket.peerCertificates. an ordered list of the peer certificates. Returns null if connection is not SSL. Annotations @Override Exceptions SSLPeerUnverifiedException: Doc from io.vertx.core.net.NetSocket.peerCertificates. SSL peer's identity has not been verified.

peerCertificates

SSLPeerUnverifiedException:

public List<Certificate> peerCertificates() throws SSLPeerUnverifiedException

Implements io.vertx.core.net.NetSocket.peerCertificates.

Returns:List<Certificate>

Doc from io.vertx.core.net.NetSocket.peerCertificates.

an ordered list of the peer certificates. Returns null if connection is not SSL.

Annotations

@Override

Exceptions

Doc from io.vertx.core.net.NetSocket.peerCertificates.

SSL peer's identity has not been verified.

remoteAddress back to summary

remoteAddress	back to summary
public SocketAddress remoteAddress() Implements io.vertx.core.net.NetSocket.remoteAddress. Returns:SocketAddress Doc from io.vertx.core.net.NetSocket.remoteAddress. the remote address for this connection, possibly `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. Annotations @Override

public SocketAddress remoteAddress()

Implements io.vertx.core.net.NetSocket.remoteAddress.

Returns:SocketAddress

Doc from io.vertx.core.net.NetSocket.remoteAddress.

the remote address for this connection, possibly 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.

Annotations

@Override

remoteAddress back to summary

remoteAddress	back to summary
public SocketAddress remoteAddress(boolean real) Implements io.vertx.core.net.NetSocket.remoteAddress. Doc from io.vertx.core.net.NetSocket.remoteAddress. Like `remoteAddress()` but returns the proxy remote address when `real` is `true` Annotations @Override

public SocketAddress remoteAddress(boolean real)

Implements io.vertx.core.net.NetSocket.remoteAddress.

Doc from io.vertx.core.net.NetSocket.remoteAddress.

Like remoteAddress() but returns the proxy remote address when real is true

Annotations

@Override

resume back to summary

resume	back to summary
public NetSocket resume() Implements io.vertx.core.net.NetSocket.resume. Doc from io.vertx.core.streams.ReadStream.resume. Resume reading, and sets the buffer in `flowing` mode. If the `ReadStream` has been paused, reading will recommence on it. Returns:NetSocket a reference to this, so the API can be used fluently Annotations @Override

public NetSocket resume()

Implements io.vertx.core.net.NetSocket.resume.

Doc from io.vertx.core.streams.ReadStream.resume.

Resume reading, and sets the buffer in flowing mode.

If the ReadStream has been paused, reading will recommence on it.

Returns:NetSocket

a reference to this, so the API can be used fluently

Annotations

@Override

sendFile back to summary

sendFile	back to summary
public Future<Void> sendFile(String filename, long offset, long length) Implements io.vertx.core.net.NetSocket.sendFile. Doc from io.vertx.core.net.NetSocket.sendFile. 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. This is a very efficient way to stream files. Parameters filename:String file name of the file to send offset:long offset length:long length Returns:Future<Void> a future result of the send operation Annotations @Override

public Future<Void> sendFile(String filename, long offset, long length)

Implements io.vertx.core.net.NetSocket.sendFile.

Doc from io.vertx.core.net.NetSocket.sendFile.

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. This is a very efficient way to stream files.

Parameters

filename:String: file name of the file to send
offset:long: offset
length:long: length

Returns:Future<Void>

a future result of the send operation

Annotations

@Override

sendFile back to summary

sendFile	back to summary
public NetSocket sendFile(String filename, long offset, long length, Handler<AsyncResult<Void>> resultHandler) Implements io.vertx.core.net.NetSocket.sendFile. Doc from io.vertx.core.net.NetSocket.sendFile. 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 Parameters filename:String file name of the file to send offset:long offset length:long length resultHandler:Handler<AsyncResult<Void>> handler Returns:NetSocket a reference to this, so the API can be used fluently Annotations @Override

public NetSocket sendFile(String filename, long offset, long length, Handler<AsyncResult<Void>> resultHandler)

Implements io.vertx.core.net.NetSocket.sendFile.

Doc from io.vertx.core.net.NetSocket.sendFile.

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

Parameters

filename:String: file name of the file to send
offset:long: offset
length:long: length
resultHandler:Handler<AsyncResult<Void>>: handler

Returns:NetSocket

a reference to this, so the API can be used fluently

Annotations

@Override

setWriteQueueMaxSize back to summary

setWriteQueueMaxSize	back to summary
public NetSocket setWriteQueueMaxSize(int maxSize) Implements io.vertx.core.net.NetSocket.setWriteQueueMaxSize. Doc from io.vertx.core.streams.WriteStream.setWriteQueueMaxSize. Set the maximum size of the write queue to `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 `io.vertx.core.net.NetSocket`, etc... Parameters maxSize:int the max size of the write stream Returns:NetSocket a reference to this, so the API can be used fluently Annotations @Override

public NetSocket setWriteQueueMaxSize(int maxSize)

Implements io.vertx.core.net.NetSocket.setWriteQueueMaxSize.

Doc from io.vertx.core.streams.WriteStream.setWriteQueueMaxSize.

Set the maximum size of the write queue to 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 io.vertx.core.net.NetSocket, etc...

Parameters

maxSize:int: the max size of the write stream

Returns:NetSocket

a reference to this, so the API can be used fluently

Annotations

@Override

sslSession	back to summary
public SSLSession sslSession() Implements io.vertx.core.net.NetSocket.sslSession. Returns:SSLSession Doc from io.vertx.core.net.NetSocket.sslSession. SSLSession associated with the underlying socket. Returns null if connection is not SSL. Annotations @Override

sslSession

public SSLSession sslSession()

Implements io.vertx.core.net.NetSocket.sslSession.

Returns:SSLSession

Doc from io.vertx.core.net.NetSocket.sslSession.

SSLSession associated with the underlying socket. Returns null if connection is not SSL.

Annotations

@Override

upgradeToSsl	back to summary
public NetSocket upgradeToSsl(Handler<AsyncResult<Void>> handler) Implements io.vertx.core.net.NetSocket.upgradeToSsl. Doc from io.vertx.core.net.NetSocket.upgradeToSsl. Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured. Parameters handler:Handler<AsyncResult<Void>> the handler will be notified when it's upgraded Returns:NetSocket a reference to this, so the API can be used fluently Annotations @Override

upgradeToSsl

public NetSocket upgradeToSsl(Handler<AsyncResult<Void>> handler)

Implements io.vertx.core.net.NetSocket.upgradeToSsl.

Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.

Parameters

handler:Handler<AsyncResult<Void>>: the handler will be notified when it's upgraded

Returns:NetSocket

a reference to this, so the API can be used fluently

Annotations

@Override

upgradeToSsl	back to summary
public NetSocket upgradeToSsl(String serverName, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.net.NetSocket.upgradeToSsl. Doc from io.vertx.core.net.NetSocket.upgradeToSsl. Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured. Parameters serverName:String the server name handler:Handler<AsyncResult<Void>> the handler will be notified when it's upgraded Returns:NetSocket a reference to this, so the API can be used fluently Annotations @Override

upgradeToSsl

public NetSocket upgradeToSsl(String serverName, Handler<AsyncResult<Void>> handler)

Implements io.vertx.core.net.NetSocket.upgradeToSsl.

Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.

Parameters

serverName:String: the server name
handler:Handler<AsyncResult<Void>>: the handler will be notified when it's upgraded

Returns:NetSocket

a reference to this, so the API can be used fluently

Annotations

@Override

upgradeToSsl back to summary

upgradeToSsl	back to summary
public Future<Void> upgradeToSsl() Implements io.vertx.core.net.NetSocket.upgradeToSsl. Doc from io.vertx.core.net.NetSocket.upgradeToSsl. Like `upgradeToSsl(Handler)` but returns a `Future` of the asynchronous result Annotations @Override

public Future<Void> upgradeToSsl()

Implements io.vertx.core.net.NetSocket.upgradeToSsl.

Like upgradeToSsl(Handler) but returns a Future of the asynchronous result

Annotations

@Override

upgradeToSsl back to summary

public Future<Void> upgradeToSsl(String serverName)

Implements io.vertx.core.net.NetSocket.upgradeToSsl.

Like upgradeToSsl(String, Handler) but returns a Future of the asynchronous result

Annotations

@Override

write back to summary

public Future<Void> write(Buffer data)

Implements io.vertx.core.streams.WriteStream.write.

Doc from io.vertx.core.streams.WriteStream.write.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Write some data to the stream.

The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the writeQueueFull method before writing. This is done automatically if using a Pipe.

When the data is moved from the queue to the actual medium, the returned Future will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.

Parameters

data:Buffer: the data to write

Returns:Future<Void>

a future completed with the write result

Annotations

@Override

write back to summary

public void write(Buffer data, Handler<AsyncResult<Void>> handler)

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Like write(Object) but with an handler called when the message has been written or failed to be written.

Annotations

@Override

write back to summary

public Future<Void> write(String str, String enc)

Write a String to the connection, encoded using the encoding enc.

Parameters

str:String: the string to write
enc:String: the encoding to use

Returns:Future<Void>

a future completed with the result

Annotations

@Override

write back to summary

public void write(String str, String enc, Handler<AsyncResult<Void>> handler)

Same as write(String, String) but with an handler called when the operation completes

Annotations

@Override

write back to summary

public Future<Void> write(String str)

Write a String to the connection, encoded in UTF-8.

Parameters

str:String: the string to write

Returns:Future<Void>

a future result of the write

Annotations

@Override

write back to summary

public void write(String str, Handler<AsyncResult<Void>> handler)