Vert.x 4.5.13 · io.vertx.core.net.impl.ConnectionBase

Modifier and Type	Field and Description
protected final ChannelHandlerContext	chctx
private boolean	closed
public static final VertxException	CLOSED_EXCEPTION An exception used to signal a closed connection to an exception handler.
private Future<Void>	closeFuture
private Handler<Void>	closeHandler
private ChannelPromise	closePromise
protected final ContextInternal	context
private Handler<Throwable>	exceptionHandler
public static final AttributeKey<SocketAddress>	LOCAL_ADDRESS_OVERRIDE
private SocketAddress	localAddress
private static final Logger	log
private static final int	MAX_REGION_SIZE
private Object	metric
private static final long	METRICS_REPORTED_BYTES_HIGH_MASK
private static final long	METRICS_REPORTED_BYTES_LOW_MASK
private boolean	needsFlush
private boolean	read
private SocketAddress	realLocalAddress
private SocketAddress	realRemoteAddress
private long	remainingBytesRead
private long	remainingBytesWritten
public static final AttributeKey<SocketAddress>	REMOTE_ADDRESS_OVERRIDE
private SocketAddress	remoteAddress
protected final VertxInternal	vertx
public final VoidChannelPromise	voidPromise
private int	writeInProgress

Access	Constructor and Description
protected	ConnectionBase(ContextInternal context, ChannelHandlerContext chctx)

Method Summary

Modifier and Type	Method and Description
public final Channel	Returns: the Netty channel - for internal usage only channel()
public ChannelPromise	channelFuture()
public final ChannelHandlerContext	channelHandlerContext()
private SocketAddress	channelLocalAddress()
private SocketAddress	channelRemoteAddress()
private void	checkCloseHandler(AsyncResult<Void> ar)
pack-priv void	close(ChannelPromise promise)
public Future<Void>	close() Close the connection
public final void	close(Handler<AsyncResult<Void>> handler) Close the connection and notifies the `handler`
public Future<Void>	Returns: a promise that will be completed when the connection becomes closed closeFuture()
public synchronized ConnectionBase	closeHandler(Handler<Void> handler)
public void	doPause()
private void	doReportBytesRead(Object msg, NetworkMetrics<S> metrics)
public void	doResume()
public void	doSetWriteQueueMaxSize(int size)
pack-priv final void	endReadAndFlush() This method is exclusively called by `VertxHandler` to signal read completion on the event-loop thread.
public synchronized ConnectionBase	exceptionHandler(Handler<Throwable> handler)
protected synchronized Handler<Throwable>	exceptionHandler()
public void	fail(Throwable the `Throwable` to propagate error) Fail the connection, the `error` will be sent to the pipeline and the connection will stop processing any further message.
public final void	flush() Asynchronous flush.
public final void	flush(ChannelPromise the promise resolved when flush occurred promise) Asynchronous flush.
public void	flushBytesRead()
public void	flushBytesWritten()
public final ContextInternal	getContext()
protected void	handleClosed()
protected void	handleEvent(Object evt)
protected void	handleException(Throwable t)
protected void	handleIdle(IdleStateEvent event) Called by the Netty handler when the connection becomes idle.
protected abstract void	handleInterestedOpsChanged()
protected void	handleMessage(Object msg)
public String	indicatedServerName()
public boolean	isNotWritable()
public boolean	isSsl()
public boolean	isTrafficShaped()
public SocketAddress	localAddress()
public SocketAddress	localAddress(boolean real)
public final synchronized void	metric(Object metric)
public final synchronized Object	metric()
public abstract NetworkMetrics<S>	metrics()
public X509Certificate[]	peerCertificateChain() References Deprecated `X509Certificate` is deprecated or references (maybe indirectly) at least one deprecated element.
public List<Certificate>	peerCertificates()
private void	queueForWrite(Object msg, boolean forceFlush, ChannelPromise promise)
pack-priv final void	read(Object msg) This method is exclusively called by `VertxHandler` to read a message on the event-loop thread.
public SocketAddress	remoteAddress()
public SocketAddress	remoteAddress(boolean real)
public String	remoteName()
public final void	reportBytesRead(Object msg)
public final void	reportBytesRead(long numberOfBytes)
public final void	reportBytesWritten(long numberOfBytes)
public final void	reportsBytesWritten(Object msg)
public final ChannelFuture	sendFile(RandomAccessFile raf, long offset, long length)
private void	sendFileRegion(RandomAccessFile the file to send file, long the file offset offset, long the file length length, ChannelPromise the write future to be completed when the transfer is done or failed writeFuture) Send a file as a file region for zero copy transfer to the socket.
protected long	sizeof(Object msg)
private SocketAddress	socketAdressOverride(AttributeKey<SocketAddress> key)
public SSLSession	sslSession()
protected boolean	supportsFileRegion()
private ChannelPromise	wrap(FutureListener<Void> handler)
private void	write(Object the message to write msg, Boolean a `null` `flush` value means to flush when there is no read in progress, otherwise it will apply the policy flush, ChannelPromise the promise receiving the completion event promise) This method is exclusively called on the event-loop thread
private void	writeClose(PromiseInternal<Void> the promise receiving the completion event promise) This method is exclusively called on the event-loop thread
public final void	writeToChannel(Object msg, FutureListener<Void> listener)
public final void	writeToChannel(Object msg, ChannelPromise promise)
public final void	writeToChannel(Object msg, boolean forceFlush, ChannelPromise promise)
public void	writeToChannel(Object obj)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

chctx	back to summary
protected final ChannelHandlerContext chctx

closed	back to summary
private boolean closed

CLOSED_EXCEPTION	back to summary
public static final VertxException CLOSED_EXCEPTION An exception used to signal a closed connection to an exception handler. Exception are expensive to create, this instance can be used for this purpose. It does not capture a stack trace to not be misleading.

closeFuture	back to summary
private Future<Void> closeFuture

closeHandler	back to summary
private Handler<Void> closeHandler

closePromise	back to summary
private ChannelPromise closePromise

context	back to summary
protected final ContextInternal context

exceptionHandler	back to summary
private Handler<Throwable> exceptionHandler

LOCAL_ADDRESS_OVERRIDE	back to summary
public static final AttributeKey<SocketAddress> LOCAL_ADDRESS_OVERRIDE

localAddress	back to summary
private SocketAddress localAddress

log	back to summary
private static final Logger log

MAX_REGION_SIZE	back to summary
private static final int MAX_REGION_SIZE

metric	back to summary
private Object metric

METRICS_REPORTED_BYTES_HIGH_MASK	back to summary
private static final long METRICS_REPORTED_BYTES_HIGH_MASK

METRICS_REPORTED_BYTES_LOW_MASK	back to summary
private static final long METRICS_REPORTED_BYTES_LOW_MASK

needsFlush	back to summary
private boolean needsFlush

read	back to summary
private boolean read

realLocalAddress	back to summary
private SocketAddress realLocalAddress

realRemoteAddress	back to summary
private SocketAddress realRemoteAddress

remainingBytesRead	back to summary
private long remainingBytesRead

remainingBytesWritten	back to summary
private long remainingBytesWritten

REMOTE_ADDRESS_OVERRIDE	back to summary
public static final AttributeKey<SocketAddress> REMOTE_ADDRESS_OVERRIDE

remoteAddress	back to summary
private SocketAddress remoteAddress

vertx	back to summary
protected final VertxInternal vertx

voidPromise	back to summary
public final VoidChannelPromise voidPromise

writeInProgress	back to summary
private int writeInProgress

Constructor Detail

ConnectionBase	back to summary
protected ConnectionBase(ContextInternal context, ChannelHandlerContext chctx)

Method Detail

channel	back to summary
public final Channel channel() Returns:Channel the Netty channel - for internal usage only

channelFuture	back to summary
public ChannelPromise channelFuture()

channelHandlerContext	back to summary
public final ChannelHandlerContext channelHandlerContext()

channelLocalAddress	back to summary
private SocketAddress channelLocalAddress()

channelRemoteAddress	back to summary
private SocketAddress channelRemoteAddress()

checkCloseHandler	back to summary
private void checkCloseHandler(AsyncResult<Void> ar)

close	back to summary
pack-priv void close(ChannelPromise promise)

close	back to summary
public Future<Void> close() Close the connection

close	back to summary
public final void close(Handler<AsyncResult<Void>> handler) Close the connection and notifies the `handler`

closeFuture	back to summary
public Future<Void> closeFuture() Returns:Future<Void> a promise that will be completed when the connection becomes closed

closeHandler	back to summary
public synchronized ConnectionBase closeHandler(Handler<Void> handler)

doPause	back to summary
public void doPause()

doReportBytesRead	back to summary
private void doReportBytesRead(Object msg, NetworkMetrics<S> metrics)

doResume	back to summary
public void doResume()

doSetWriteQueueMaxSize	back to summary
public void doSetWriteQueueMaxSize(int size)

endReadAndFlush	back to summary
pack-priv final void endReadAndFlush() This method is exclusively called by `VertxHandler` to signal read completion on the event-loop thread.

exceptionHandler	back to summary
public synchronized ConnectionBase exceptionHandler(Handler<Throwable> handler)

exceptionHandler	back to summary
protected synchronized Handler<Throwable> exceptionHandler()

fail back to summary

fail	back to summary
public void fail(Throwable error) Fail the connection, the `error` will be sent to the pipeline and the connection will stop processing any further message. Parameters error:Throwable the `Throwable` to propagate

public void fail(Throwable error)

Fail the connection, the error will be sent to the pipeline and the connection will stop processing any further message.

Parameters

error:Throwable: the Throwable to propagate

flush	back to summary
public final void flush() Asynchronous flush.

flush

back to summary

public final void flush(ChannelPromise promise)

Asynchronous flush.

Parameters

promise:ChannelPromise: the promise resolved when flush occurred

flushBytesRead	back to summary
public void flushBytesRead()

flushBytesWritten	back to summary
public void flushBytesWritten()

getContext	back to summary
public final ContextInternal getContext()

handleClosed	back to summary
protected void handleClosed()

handleEvent	back to summary
protected void handleEvent(Object evt)

handleException	back to summary
protected void handleException(Throwable t)

handleIdle

back to summary

protected void handleIdle(IdleStateEvent event)

Called by the Netty handler when the connection becomes idle. The default implementation closes the connection.

Subclasses can override it to prevent the idle event to happen (e.g when the connection is pooled) or perform extra work when the idle event happens.

handleInterestedOpsChanged	back to summary
protected abstract void handleInterestedOpsChanged()

handleMessage	back to summary
protected void handleMessage(Object msg)

indicatedServerName	back to summary
public String indicatedServerName()

isNotWritable	back to summary
public boolean isNotWritable()

isSsl	back to summary
public boolean isSsl()

isTrafficShaped	back to summary
public boolean isTrafficShaped()

localAddress	back to summary
public SocketAddress localAddress()

localAddress	back to summary
public SocketAddress localAddress(boolean real)

metric	back to summary
public final synchronized void metric(Object metric)

metric	back to summary
public final synchronized Object metric()

metrics	back to summary
public abstract NetworkMetrics<S> metrics()

peerCertificateChain	back to summary
public X509Certificate[] peerCertificateChain() throws SSLPeerUnverifiedException References Deprecated `X509Certificate` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

peerCertificates	back to summary
public List<Certificate> peerCertificates() throws SSLPeerUnverifiedException

queueForWrite	back to summary
private void queueForWrite(Object msg, boolean forceFlush, ChannelPromise promise)

read	back to summary
pack-priv final void read(Object msg) This method is exclusively called by `VertxHandler` to read a message on the event-loop thread.

remoteAddress	back to summary
public SocketAddress remoteAddress()

remoteAddress	back to summary
public SocketAddress remoteAddress(boolean real)

remoteName	back to summary
public String remoteName()

reportBytesRead	back to summary
public final void reportBytesRead(Object msg)

reportBytesRead	back to summary
public final void reportBytesRead(long numberOfBytes)

reportBytesWritten	back to summary
public final void reportBytesWritten(long numberOfBytes)

reportsBytesWritten	back to summary
public final void reportsBytesWritten(Object msg)

sendFile	back to summary
public final ChannelFuture sendFile(RandomAccessFile raf, long offset, long length) throws IOException

sendFileRegion

back to summary

private void sendFileRegion(RandomAccessFile file, long offset, long length, ChannelPromise writeFuture)

Send a file as a file region for zero copy transfer to the socket. The implementation splits the file into multiple regions to avoid stalling the pipeline and producing idle timeouts for very large files.

Parameters

file:RandomAccessFile: the file to send
offset:long: the file offset
length:long: the file length
writeFuture:ChannelPromise: the write future to be completed when the transfer is done or failed

sizeof	back to summary
protected long sizeof(Object msg)

socketAdressOverride	back to summary
private SocketAddress socketAdressOverride(AttributeKey<SocketAddress> key)

sslSession	back to summary
public SSLSession sslSession()

supportsFileRegion	back to summary
protected boolean supportsFileRegion()

wrap	back to summary
private ChannelPromise wrap(FutureListener<Void> handler)

write back to summary

private void write(Object msg, Boolean flush, ChannelPromise promise)

This method is exclusively called on the event-loop thread

Parameters

msg:Object: the message to write
flush:Boolean: a null flush value means to flush when there is no read in progress, otherwise it will apply the policy
promise:ChannelPromise: the promise receiving the completion event

writeClose

back to summary

private void writeClose(PromiseInternal<Void> promise)

This method is exclusively called on the event-loop thread

Parameters

promise:PromiseInternal<Void>: the promise receiving the completion event

writeToChannel	back to summary
public final void writeToChannel(Object msg, FutureListener<Void> listener)

writeToChannel	back to summary
public final void writeToChannel(Object msg, ChannelPromise promise)

writeToChannel	back to summary
public final void writeToChannel(Object msg, boolean forceFlush, ChannelPromise promise)

writeToChannel	back to summary
public void writeToChannel(Object obj)

public abstract Class ConnectionBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail