public Class NetSocketImpl

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

callDrainHandler	back to summary
private synchronized void callDrainHandler()

closeHandler	back to summary
public NetSocketImpl closeHandler(Handler<Void> handler) Overrides io.vertx.core.net.impl.ConnectionBase.closeHandler. Annotations @Override

closeHandler

public NetSocketImpl closeHandler(Handler<Void> handler)

Overrides io.vertx.core.net.impl.ConnectionBase.closeHandler.

Annotations

@Override

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

drainHandler

public synchronized NetSocket drainHandler(Handler<Void> drainHandler)

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

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

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

endHandler	back to summary
private synchronized Handler<Void> endHandler()

endHandler	back to summary
public synchronized NetSocket endHandler(Handler<Void> endHandler) 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> endHandler)

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

eventHandler back to summary

eventHandler	back to summary
public synchronized NetSocketInternal eventHandler(Handler<Object> handler) Implements io.vertx.core.net.impl.NetSocketInternal.eventHandler. Doc from io.vertx.core.net.impl.NetSocketInternal.eventHandler. Set an handler to process pipeline user events. The handler should take care of releasing event, e.g calling `ReferenceCountUtil.release(evt)`. Parameters handler:Handler<Object> the handler to set Returns:NetSocketInternal a reference to this, so the API can be used fluently Annotations @Override

public synchronized NetSocketInternal eventHandler(Handler<Object> handler)

Implements io.vertx.core.net.impl.NetSocketInternal.eventHandler.

Doc from io.vertx.core.net.impl.NetSocketInternal.eventHandler.

Set an handler to process pipeline user events. The handler should take care of releasing event, e.g calling ReferenceCountUtil.release(evt).

Parameters

handler:Handler<Object>: the handler to set

Returns:NetSocketInternal

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

Annotations

@Override

exceptionHandler	back to summary
public NetSocketImpl exceptionHandler(Handler<Throwable> handler) Overrides io.vertx.core.net.impl.ConnectionBase.exceptionHandler. Implements io.vertx.core.net.NetSocket.exceptionHandler.

exceptionHandler

public NetSocketImpl exceptionHandler(Handler<Throwable> handler)

Overrides io.vertx.core.net.impl.ConnectionBase.exceptionHandler.

Implements io.vertx.core.net.NetSocket.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

handleClosed	back to summary
protected void handleClosed() Overrides io.vertx.core.net.impl.ConnectionBase.handleClosed. Annotations @Override

handleClosed

protected void handleClosed()

Overrides io.vertx.core.net.impl.ConnectionBase.handleClosed.

Annotations

@Override

handleEvent	back to summary
protected void handleEvent(Object evt) Overrides io.vertx.core.net.impl.ConnectionBase.handleEvent. Annotations @Override

handleEvent

protected void handleEvent(Object evt)

Overrides io.vertx.core.net.impl.ConnectionBase.handleEvent.

Annotations

@Override

handleInterestedOpsChanged	back to summary
protected void handleInterestedOpsChanged() Implements abstract io.vertx.core.net.impl.ConnectionBase.handleInterestedOpsChanged. Annotations @Override

handleInterestedOpsChanged

protected void handleInterestedOpsChanged()

Implements abstract io.vertx.core.net.impl.ConnectionBase.handleInterestedOpsChanged.

Annotations

@Override

handleMessage	back to summary
public void handleMessage(Object msg) Overrides io.vertx.core.net.impl.ConnectionBase.handleMessage. Annotations @Override

handleMessage

public void handleMessage(Object msg)

Overrides io.vertx.core.net.impl.ConnectionBase.handleMessage.

Annotations

@Override

handler	back to summary
private synchronized Handler<Buffer> handler()

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

handler

public synchronized NetSocket handler(Handler<Buffer> dataHandler)

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

Annotations

@Override

messageHandler	back to summary
private synchronized Handler<Object> messageHandler()

messageHandler back to summary

messageHandler	back to summary
public synchronized NetSocketInternal messageHandler(Handler<Object> handler) Implements io.vertx.core.net.impl.NetSocketInternal.messageHandler. Doc from io.vertx.core.net.impl.NetSocketInternal.messageHandler. Set a `handler` on this socket to process the messages produced by this socket. The message can be `io.netty.buffer.ByteBuf` or other messages produced by channel pipeline handlers. The handler should take care of releasing pooled / direct messages. The handler replaces any `handler(Handler)` previously set. Parameters handler:Handler<Object> the handler to set Returns:NetSocketInternal a reference to this, so the API can be used fluently Annotations @Override

public synchronized NetSocketInternal messageHandler(Handler<Object> handler)

Implements io.vertx.core.net.impl.NetSocketInternal.messageHandler.

Doc from io.vertx.core.net.impl.NetSocketInternal.messageHandler.

Set a handler on this socket to process the messages produced by this socket. The message can be io.netty.buffer.ByteBuf or other messages produced by channel pipeline handlers.

The handler should take care of releasing pooled / direct messages.

The handler replaces any handler(Handler) previously set.

Parameters

handler:Handler<Object>: the handler to set

Returns:NetSocketInternal

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

Annotations

@Override

metrics	back to summary
public TCPMetrics<S> metrics() Implements abstract io.vertx.core.net.impl.ConnectionBase.metrics. Annotations @Override

metrics

public TCPMetrics<S> metrics()

Implements abstract io.vertx.core.net.impl.ConnectionBase.metrics.

Annotations

@Override

pause back to summary

pause	back to summary
public synchronized 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 synchronized 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

registerEventBusHandler	back to summary
pack-priv void registerEventBusHandler()

resume back to summary

resume	back to summary
public synchronized 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 synchronized 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, final 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, final 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

unregisterEventBusHandler	back to summary
pack-priv void unregisterEventBusHandler()

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

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

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

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

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

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(String str, Handler<AsyncResult<Void>> handler)

Same as write(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 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 void write(Buffer message, 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

private void write(ByteBuf buff, Handler<AsyncResult<Void>> handler)

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

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

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

writeHandlerID back to summary

public String writeHandlerID()

Implements io.vertx.core.net.NetSocket.writeHandlerID.

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

When a NetSocket is created, it may register an event handler with the event bus, the ID of that handler is given by writeHandlerID.

By default, no handler is registered, the feature must be enabled via NetClientOptions#setRegisterWriteHandler(boolean) or NetServerOptions#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:String

the write handler ID

Annotations

@Override

writeMessage