NIOConnection (grizzly-framework 3.0.0 API)

java.lang.Object
- org.glassfish.grizzly.nio.NIOConnection

All Implemented Interfaces:

AttributeStorage, Closeable, Connection<SocketAddress>, MonitoringAware<ConnectionProbe>, OutputSink, Readable<SocketAddress>, Writeable<SocketAddress>

Direct Known Subclasses:

TCPNIOConnection, UDPNIOConnection
```
public abstract class NIOConnection
extends Object
implements Connection<SocketAddress>
```
Common Connection implementation for Java NIO Connections.

Author:

Alexey Stashok

Nested Class Summary
- Nested classes/interfaces inherited from interface org.glassfish.grizzly.Connection
  Connection.CloseListener, Connection.CloseType

Field Summary

Fields
Modifier and Type	Field and Description
`protected AttributeHolder`	`attributes`
`protected SelectableChannel`	`channel`
`protected static AtomicReferenceFieldUpdater<NIOConnection,Object>`	`connectCloseSemaphoreUpdater`
`protected boolean`	`isBlocking`
`protected boolean`	`isStandalone`
`protected int`	`maxAsyncWriteQueueSize`
`protected DefaultMonitoringConfig<ConnectionProbe>`	`monitoringConfig` Connection probes
`protected static Object`	`NOTIFICATION_CLOSED_COMPLETE`
`protected static Object`	`NOTIFICATION_INITIALIZED`
`protected Processor`	`processor`
`protected ProcessorSelector`	`processorSelector`
`protected long`	`readTimeoutMillis`
`protected SelectionKey`	`selectionKey`
`protected SelectorRunner`	`selectorRunner`
`protected NIOTransport`	`transport`
`protected long`	`writeTimeoutMillis`
`protected short`	`zeroByteReadCount`

Constructor Summary

Constructors
Constructor and Description

NIOConnection(NIOTransport transport)

Constructors
Constructor and Description
`NIOConnection(NIOTransport transport)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCloseListener(CloseListener closeListener)` Add the `Connection.CloseListener`, which will be notified once `Connection` will be closed.
`void`	`addCloseListener(Connection.CloseListener closeListener)` Add the `Connection.CloseListener`, which will be notified once `Connection` will be closed.
`void`	`assertOpen()` Checks if this `Connection` is open and ready to be used.
`void`	`attachToSelectorRunner(SelectorRunner selectorRunner)`
`protected void`	`checkEmptyRead(int size)`
`GrizzlyFuture<Closeable>`	`close()` Gracefully close the `Connection`
`void`	`close(CompletionHandler<Closeable> completionHandler)` Deprecated. please use `close()` with the following `GrizzlyFuture.addCompletionHandler(org.glassfish.grizzly.CompletionHandler)` call
`GrizzlyFuture<CloseReason>`	`closeFuture()`
`protected void`	`closeGracefully0(CompletionHandler<Closeable> completionHandler, CloseReason closeReason)`
`void`	`closeSilently()` Gracefully close the `Connection` silently, no notification required on completion or failure.
`void`	`closeWithReason(IOException reason)` Gracefully closes the `Connection` and provides the reason description.
`void`	`configureBlocking(boolean isBlocking)` Sets the `Connection` mode.
`void`	`configureStandalone(boolean isStandalone)`
`void`	`detachSelectorRunner()`
`void`	`disableIOEvent(IOEvent ioEvent)`
`protected void`	`doClose()` Do the actual connection close.
`protected void`	`enableInitialOpRead()` Enables OP_READ if it has never been enabled before.
`void`	`enableIOEvent(IOEvent ioEvent)`
`void`	`executeInEventThread(IOEvent event, Runnable runnable)` Executes the `Runnable` in the thread, responsible for running the given type of event on this `Connection`.
`TaskQueue<AsyncReadQueueRecord>`	`getAsyncReadQueue()`
`TaskQueue<AsyncWriteQueueRecord>`	`getAsyncWriteQueue()`
`AttributeHolder`	`getAttributes()` Get associated `AttributeHolder`.
`SelectableChannel`	`getChannel()`
`CloseReason`	`getCloseReason()` Returns `CloseReason` if this `Connection` has been closed, or `null` otherwise.
`int`	`getMaxAsyncWriteQueueSize()` Get the max size (in bytes) of asynchronous write queue associated with connection.
`MemoryManager<?>`	`getMemoryManager()`
`MonitoringConfig<ConnectionProbe>`	`getMonitoringConfig()` Return the object associated `MonitoringConfig`.
`Processor`	`getProcessor()` Gets the default `Processor`, which will process `Connection` I/O events.
`ProcessorSelector`	`getProcessorSelector()` Gets the default `ProcessorSelector`, which will be used to get `Processor` to process `Connection` I/O events, in case if this `Connection`'s `Processor` is `null`.
`long`	`getReadTimeout(TimeUnit timeUnit)` Returns the current value for the blocking read timeout converted to the provided `TimeUnit` specification.
`SelectionKey`	`getSelectionKey()`
`SelectorRunner`	`getSelectorRunner()`
`Transport`	`getTransport()` Get the `Transport`, to which this `Connection` belongs to.
`long`	`getWriteTimeout(TimeUnit timeUnit)` Returns the current value for the blocking write timeout converted to the provided `TimeUnit` specification.
`boolean`	`isBlocking()`
`boolean`	`isClosed()`
`boolean`	`isOpen()` Is `Connection` open and ready.
`boolean`	`isStandalone()`
`void`	`notifyConnectionError(Throwable error)` Method gets invoked, when error occur during the `Connection` lifecycle.
`protected static void`	`notifyIOEventDisabled(NIOConnection connection, IOEvent ioEvent)` Notify registered `ConnectionProbe`s about the IO Event disabled event.
`protected static void`	`notifyIOEventEnabled(NIOConnection connection, IOEvent ioEvent)` Notify registered `ConnectionProbe`s about the IO Event enabled event.
`protected static void`	`notifyIOEventReady(NIOConnection connection, IOEvent ioEvent)` Notify registered `ConnectionProbe`s about the IO Event ready event.
`protected static void`	`notifyProbesAccept(NIOConnection serverConnection, NIOConnection clientConnection)` Notify registered `ConnectionProbe`s about the accept event.
`protected static void`	`notifyProbesBind(NIOConnection connection)` Notify registered `ConnectionProbe`s about the bind event.
`protected static void`	`notifyProbesClose(NIOConnection connection)` Notify registered `ConnectionProbe`s about the close event.
`protected static void`	`notifyProbesConnect(NIOConnection connection)` Notify registered `ConnectionProbe`s about the connect event.
`protected static void`	`notifyProbesError(NIOConnection connection, Throwable error)` Notify registered `ConnectionProbe`s about the error.
`protected static void`	`notifyProbesRead(NIOConnection connection, Buffer data, int size)` Notify registered `ConnectionProbe`s about the read event.
`protected static void`	`notifyProbesWrite(NIOConnection connection, Buffer data, long size)` Notify registered `ConnectionProbe`s about the write event.
`Processor`	`obtainProcessor(IOEvent ioEvent)` Gets the `Processor`, which will process `Connection` I/O event.
`<E> E`	`obtainProcessorState(Processor processor, NullaryFunction<E> factory)` Returns the `Processor` state associated with this `Connection`.
`protected void`	`preClose()`
`<M> GrizzlyFuture<ReadResult<M,SocketAddress>>`	`read()` Method reads data.
`<M> void`	`read(CompletionHandler<ReadResult<M,SocketAddress>> completionHandler)`
`boolean`	`removeCloseListener(CloseListener closeListener)` Remove the `Connection.CloseListener`.
`boolean`	`removeCloseListener(Connection.CloseListener closeListener)` Remove the `Connection.CloseListener`.
`protected void`	`setChannel(SelectableChannel channel)`
`void`	`setMaxAsyncWriteQueueSize(int maxAsyncWriteQueueSize)` Set the max size (in bytes) of asynchronous write queue associated with connection.
`void`	`setProcessor(Processor preferableProcessor)` Sets the default `Processor`, which will process `Connection` I/O events.
`void`	`setProcessorSelector(ProcessorSelector preferableProcessorSelector)` Sets the default `ProcessorSelector`, which will be used to get `Processor` to process `Connection` I/O events, in case if this `Connection`'s `Processor` is `null`.
`void`	`setReadTimeout(long timeout, TimeUnit timeUnit)` Specifies the timeout for the blocking reads.
`protected void`	`setSelectionKey(SelectionKey selectionKey)`
`protected void`	`setSelectorRunner(SelectorRunner selectorRunner)`
`void`	`setWriteTimeout(long timeout, TimeUnit timeUnit)` Specifies the timeout for the blocking writes.
`void`	`simulateIOEvent(IOEvent ioEvent)`
`GrizzlyFuture<Closeable>`	`terminate()` Close the `Connection`
`protected void`	`terminate0(CompletionHandler<Closeable> completionHandler, CloseReason reason)`
`void`	`terminateSilently()` Close the `Connection` silently, no notification required on completion or failure.
`void`	`terminateWithReason(IOException reason)` Closes the `Connection` and provides the reason description.
`<M> GrizzlyFuture<WriteResult<M,SocketAddress>>`	`write(M message)` Method writes the `buffer`.
`<M> void`	`write(M message, CompletionHandler<WriteResult<M,SocketAddress>> completionHandler)` Method writes the `buffer`.
`<M> void`	`write(M message, CompletionHandler<WriteResult<M,SocketAddress>> completionHandler, PushBackHandler pushbackHandler)` Deprecated.
`<M> void`	`write(SocketAddress dstAddress, M message, CompletionHandler<WriteResult<M,SocketAddress>> completionHandler)` Method writes the `buffer` to the specific address.
`<M> void`	`write(SocketAddress dstAddress, M message, CompletionHandler<WriteResult<M,SocketAddress>> completionHandler, PushBackHandler pushbackHandler)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.glassfish.grizzly.Connection
getLocalAddress, getPeerAddress, getReadBufferSize, getWriteBufferSize, setReadBufferSize, setWriteBufferSize

Methods inherited from interface org.glassfish.grizzly.OutputSink
canWrite, canWrite, notifyCanWrite, notifyCanWrite

- Field Detail
  - NOTIFICATION_INITIALIZED
```
protected static final Object NOTIFICATION_INITIALIZED
```
  - NOTIFICATION_CLOSED_COMPLETE
```
protected static final Object NOTIFICATION_CLOSED_COMPLETE
```
  - transport
```
protected final NIOTransport transport
```
  - maxAsyncWriteQueueSize
```
protected volatile int maxAsyncWriteQueueSize
```
  - readTimeoutMillis
```
protected volatile long readTimeoutMillis
```
  - writeTimeoutMillis
```
protected volatile long writeTimeoutMillis
```
  - channel
```
protected volatile SelectableChannel channel
```
  - selectionKey
```
protected volatile SelectionKey selectionKey
```
  - selectorRunner
```
protected volatile SelectorRunner selectorRunner
```
  - processor
```
protected volatile Processor processor
```
  - processorSelector
```
protected volatile ProcessorSelector processorSelector
```
  - attributes
```
protected final AttributeHolder attributes
```
  - connectCloseSemaphoreUpdater
```
protected static final AtomicReferenceFieldUpdater<NIOConnection,Object> connectCloseSemaphoreUpdater
```
  - isBlocking
```
protected volatile boolean isBlocking
```
  - isStandalone
```
protected volatile boolean isStandalone
```
  - zeroByteReadCount
```
protected short zeroByteReadCount
```
  - monitoringConfig
```
protected final DefaultMonitoringConfig<ConnectionProbe> monitoringConfig
```
    Connection probes
- Constructor Detail
  - NIOConnection
```
public NIOConnection(NIOTransport transport)
```
- Method Detail
  - configureBlocking
```
public void configureBlocking(boolean isBlocking)
```
    Description copied from interface: Connection
    
    Sets the Connection mode.
    
    Specified by:
    
    configureBlocking in interface Connection<SocketAddress>
    
    Parameters:
    
    isBlocking - the Connection mode. true, if Connection should operate in blocking mode, or false otherwise.
  - isBlocking
```
public boolean isBlocking()
```
    Specified by:
    
    isBlocking in interface Connection<SocketAddress>
    
    Returns:
    
    the Connection mode. true, if Connection is operating in blocking mode, or false otherwise.
  - getMemoryManager
```
public MemoryManager<?> getMemoryManager()
```
    Specified by:
    
    getMemoryManager in interface Connection<SocketAddress>
    
    Returns:
    
    an associated MemoryManager. It's a shortcut for Connection.getTransport().getMemoryManager()
  - configureStandalone
```
public void configureStandalone(boolean isStandalone)
```
    Specified by:
    
    configureStandalone in interface Connection<SocketAddress>
  - isStandalone
```
public boolean isStandalone()
```
    Specified by:
    
    isStandalone in interface Connection<SocketAddress>
  - getTransport
```
public Transport getTransport()
```
    Description copied from interface: Connection
    
    Get the Transport, to which this Connection belongs to.
    
    Specified by:
    
    getTransport in interface Connection<SocketAddress>
    
    Returns:
    
    the Transport, to which this Connection belongs to.
  - getMaxAsyncWriteQueueSize
```
public int getMaxAsyncWriteQueueSize()
```
    Get the max size (in bytes) of asynchronous write queue associated with connection.
    
    Specified by:
    
    getMaxAsyncWriteQueueSize in interface Connection<SocketAddress>
    
    Returns:
    
    the max size (in bytes) of asynchronous write queue associated with connection.
  - setMaxAsyncWriteQueueSize
```
public void setMaxAsyncWriteQueueSize(int maxAsyncWriteQueueSize)
```
    Set the max size (in bytes) of asynchronous write queue associated with connection.
    
    Specified by:
    
    setMaxAsyncWriteQueueSize in interface Connection<SocketAddress>
    
    Parameters:
    
    maxAsyncWriteQueueSize - the max size (in bytes) of asynchronous write queue associated with connection.
  - getReadTimeout
```
public long getReadTimeout(TimeUnit timeUnit)
```
    Description copied from interface: Connection
    
    Returns the current value for the blocking read timeout converted to the provided TimeUnit specification. If this value hasn't been explicitly set, it will default to 30 seconds.
    
    Specified by:
    
    getReadTimeout in interface Connection<SocketAddress>
    
    Parameters:
    
    timeUnit - the TimeUnit to convert the returned result to.
    
    Returns:
    
    the read timeout value
  - setReadTimeout
```
public void setReadTimeout(long timeout,
                           TimeUnit timeUnit)
```
    Description copied from interface: Connection
    
    Specifies the timeout for the blocking reads. This may be overridden on a per-connection basis. A value of zero or less effectively disables the timeout.
    
    Specified by:
    
    setReadTimeout in interface Connection<SocketAddress>
    
    Parameters:
    
    timeout - the new timeout value
    
    timeUnit - the TimeUnit specification of the provided value.
    
    See Also:
    
    Connection.setReadTimeout(long, java.util.concurrent.TimeUnit)
  - getWriteTimeout
```
public long getWriteTimeout(TimeUnit timeUnit)
```
    Description copied from interface: Connection
    
    Returns the current value for the blocking write timeout converted to the provided TimeUnit specification. If this value hasn't been explicitly set, it will default to 30 seconds.
    
    Specified by:
    
    getWriteTimeout in interface Connection<SocketAddress>
    
    Parameters:
    
    timeUnit - the TimeUnit to convert the returned result to.
    
    Returns:
    
    the write timeout value
  - setWriteTimeout
```
public void setWriteTimeout(long timeout,
                            TimeUnit timeUnit)
```
    Description copied from interface: Connection
    
    Specifies the timeout for the blocking writes. This may be overridden on a per-connection basis. A value of zero or less effectively disables the timeout.
    
    Specified by:
    
    setWriteTimeout in interface Connection<SocketAddress>
    
    Parameters:
    
    timeout - the new timeout value
    
    timeUnit - the TimeUnit specification of the provided value.
    
    See Also:
    
    Connection.setWriteTimeout(long, java.util.concurrent.TimeUnit)
  - getSelectorRunner
```
public SelectorRunner getSelectorRunner()
```
  - setSelectorRunner
```
protected void setSelectorRunner(SelectorRunner selectorRunner)
```
  - attachToSelectorRunner
```
public void attachToSelectorRunner(SelectorRunner selectorRunner)
                            throws IOException
```
    Throws:
    
    IOException
  - detachSelectorRunner
```
public void detachSelectorRunner()
                          throws IOException
```
    Throws:
    
    IOException
  - getChannel
```
public SelectableChannel getChannel()
```
  - setChannel
```
protected void setChannel(SelectableChannel channel)
```
  - getSelectionKey
```
public SelectionKey getSelectionKey()
```
  - setSelectionKey
```
protected void setSelectionKey(SelectionKey selectionKey)
```
  - obtainProcessor
```
public Processor obtainProcessor(IOEvent ioEvent)
```
    Description copied from interface: Connection
    
    Gets the Processor, which will process Connection I/O event. If Processor is null, - then Transport will try to get Processor using Connection's ProcessorSelector.select(IOEvent, Connection). If ProcessorSelector, associated withthe Connection is also null - will ask Transport for a Processor.
    
    Specified by:
    
    obtainProcessor in interface Connection<SocketAddress>
    
    Parameters:
    
    ioEvent - event to obtain the processor for
    
    Returns:
    
    the default Processor, which will process Connection I/O events.
  - getProcessor
```
public Processor getProcessor()
```
    Description copied from interface: Connection
    
    Gets the default Processor, which will process Connection I/O events. If Processor is null, - then Transport will try to get Processor using Connection's ProcessorSelector.select(IOEvent, Connection). If ProcessorSelector, associated withthe Connection is also null - Transport will try to get Processor using own settings.
    
    Specified by:
    
    getProcessor in interface Connection<SocketAddress>
    
    Returns:
    
    the default Processor, which will process Connection I/O events.
  - setProcessor
```
public void setProcessor(Processor preferableProcessor)
```
    Description copied from interface: Connection
    
    Sets the default Processor, which will process Connection I/O events. If Processor is null, - then Transport will try to get Processor using Connection's ProcessorSelector.select(IOEvent, Connection). If ProcessorSelector, associated withthe Connection is also null - Transport will try to get Processor using own settings.
    
    Specified by:
    
    setProcessor in interface Connection<SocketAddress>
    
    Parameters:
    
    preferableProcessor - the default Processor, which will process Connection I/O events.
  - getProcessorSelector
```
public ProcessorSelector getProcessorSelector()
```
    Description copied from interface: Connection
    
    Gets the default ProcessorSelector, which will be used to get Processor to process Connection I/O events, in case if this Connection's Processor is null.
    
    Specified by:
    
    getProcessorSelector in interface Connection<SocketAddress>
    
    Returns:
    
    the default ProcessorSelector, which will be used to get Processor to process Connection I/O events, in case if this Connection's Processor is null.
  - setProcessorSelector
```
public void setProcessorSelector(ProcessorSelector preferableProcessorSelector)
```
    Description copied from interface: Connection
    
    Sets the default ProcessorSelector, which will be used to get Processor to process Connection I/O events, in case if this Connection's Processor is null.
    
    Specified by:
    
    setProcessorSelector in interface Connection<SocketAddress>
    
    Parameters:
    
    preferableProcessorSelector - the default ProcessorSelector, which will be used to get Processor to process Connection I/O events, in case if this Connection's Processor is null.
  - obtainProcessorState
```
public <E> E obtainProcessorState(Processor processor,
                                  NullaryFunction<E> factory)
```
    Description copied from interface: Connection
    
    Returns the Processor state associated with this Connection.
    
    Specified by:
    
    obtainProcessorState in interface Connection<SocketAddress>
    
    Type Parameters:
    
    E - state of the Processor
    
    Parameters:
    
    processor - Processor
    
    factory - factory that is used to initialise the state
    
    Returns:
    
    the Processor state associated with this Connection.
  - executeInEventThread
```
public void executeInEventThread(IOEvent event,
                                 Runnable runnable)
```
    Description copied from interface: Connection
    
    Executes the Runnable in the thread, responsible for running the given type of event on this Connection. The thread will be chosen based on Transport settings, especially current I/O strategy.
    
    Specified by:
    
    executeInEventThread in interface Connection<SocketAddress>
    
    Parameters:
    
    event - event to get the thread pool from
    
    runnable - Runnable to run in the thread
  - getAsyncReadQueue
```
public TaskQueue<AsyncReadQueueRecord> getAsyncReadQueue()
```
  - getAsyncWriteQueue
```
public TaskQueue<AsyncWriteQueueRecord> getAsyncWriteQueue()
```
  - getAttributes
```
public AttributeHolder getAttributes()
```
    Description copied from interface: AttributeStorage
    
    Get associated AttributeHolder. Implementation may return null if AttributeHolder wasn't initialized yet.
    
    Specified by:
    
    getAttributes in interface AttributeStorage
    
    Returns:
    
    associated AttributeHolder. Implementation may return null if AttributeHolder wasn't initialized yet.
  - read
```
public <M> GrizzlyFuture<ReadResult<M,SocketAddress>> read()
```
    Description copied from interface: Readable
    
    Method reads data.
    
    Specified by:
    
    read in interface Readable<SocketAddress>
    
    Type Parameters:
    
    M - type of data to read
    
    Returns:
    
    Future, using which it's possible to check the result
  - read
```
public <M> void read(CompletionHandler<ReadResult<M,SocketAddress>> completionHandler)
```
    Specified by:
    
    read in interface Readable<SocketAddress>
  - write
```
public <M> GrizzlyFuture<WriteResult<M,SocketAddress>> write(M message)
```
    Description copied from interface: Writeable
    
    Method writes the buffer.
    
    Specified by:
    
    write in interface Writeable<SocketAddress>
    
    Type Parameters:
    
    M - type of data to be written
    
    Parameters:
    
    message - the buffer, from which the data will be written
    
    Returns:
    
    Future, using which it's possible to check the result
  - write
```
public <M> void write(M message,
                      CompletionHandler<WriteResult<M,SocketAddress>> completionHandler)
```
    Description copied from interface: Writeable
    
    Method writes the buffer.
    
    Specified by:
    
    write in interface Writeable<SocketAddress>
    
    Type Parameters:
    
    M - type of data to be written
    
    Parameters:
    
    message - the buffer, from which the data will be written
    
    completionHandler - CompletionHandler, which will get notified, when write will be completed
  - write
```
@Deprecated
public <M> void write(M message,
                                  CompletionHandler<WriteResult<M,SocketAddress>> completionHandler,
                                  PushBackHandler pushbackHandler)
```
    Deprecated.
    
    Description copied from interface: Writeable
    
    Method writes the buffer.
    
    Specified by:
    
    write in interface Writeable<SocketAddress>
    
    Type Parameters:
    
    M - type of data to be written
    
    Parameters:
    
    message - the buffer, from which the data will be written
    
    completionHandler - CompletionHandler, which will get notified, when write will be completed
    
    pushbackHandler - PushBackHandler, which will be notified if message was accepted by transport write queue or refused
  - write
```
public <M> void write(SocketAddress dstAddress,
                      M message,
                      CompletionHandler<WriteResult<M,SocketAddress>> completionHandler)
```
    Description copied from interface: Writeable
    
    Method writes the buffer to the specific address.
    
    Specified by:
    
    write in interface Writeable<SocketAddress>
    
    Type Parameters:
    
    M - type of data to be written
    
    Parameters:
    
    dstAddress - the destination address the buffer will be sent to
    
    message - the buffer, from which the data will be written
    
    completionHandler - CompletionHandler, which will get notified, when write will be completed
  - write
```
@Deprecated
public <M> void write(SocketAddress dstAddress,
                                  M message,
                                  CompletionHandler<WriteResult<M,SocketAddress>> completionHandler,
                                  PushBackHandler pushbackHandler)
```
    Deprecated.
    
    Description copied from interface: Writeable
    
    Method writes the buffer to the specific address.
    
    Specified by:
    
    write in interface Writeable<SocketAddress>
    
    Type Parameters:
    
    M - type of data to be written
    
    Parameters:
    
    dstAddress - the destination address the buffer will be sent to
    
    message - the buffer, from which the data will be written
    
    completionHandler - CompletionHandler, which will get notified, when write will be completed
    
    pushbackHandler - PushBackHandler, which will be notified if message was accepted by transport write queue or refused
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: Connection
    
    Is Connection open and ready. Returns true, if connection is open and ready, or false otherwise.
    
    Specified by:
    
    isOpen in interface Closeable
    
    Specified by:
    
    isOpen in interface Connection<SocketAddress>
    
    Returns:
    
    true, if connection is open and ready, or false otherwise.
  - assertOpen
```
public void assertOpen()
                throws IOException
```
    Description copied from interface: Connection
    
    Checks if this Connection is open and ready to be used. If this Connection is closed - this method throws IOException giving the reason why this Connection was closed.
    
    Specified by:
    
    assertOpen in interface Closeable
    
    Specified by:
    
    assertOpen in interface Connection<SocketAddress>
    
    Throws:
    
    IOException - giving the reason why this Closeable was closed.
  - isClosed
```
public boolean isClosed()
```
  - getCloseReason
```
public CloseReason getCloseReason()
```
    Description copied from interface: Connection
    
    Returns CloseReason if this Connection has been closed, or null otherwise.
    
    Specified by:
    
    getCloseReason in interface Connection<SocketAddress>
    
    Returns:
    
    CloseReason if this Connection has been closed, or null otherwise
  - terminateSilently
```
public void terminateSilently()
```
    Description copied from interface: Connection
    
    Close the Connection silently, no notification required on completion or failure.
    
    Specified by:
    
    terminateSilently in interface Closeable
    
    Specified by:
    
    terminateSilently in interface Connection<SocketAddress>
  - terminate
```
public GrizzlyFuture<Closeable> terminate()
```
    Description copied from interface: Connection
    
    Close the Connection
    
    Specified by:
    
    terminate in interface Closeable
    
    Specified by:
    
    terminate in interface Connection<SocketAddress>
    
    Returns:
    
    Future, which could be checked in case, if close operation will be run asynchronously
  - terminateWithReason
```
public void terminateWithReason(IOException reason)
```
    Description copied from interface: Connection
    
    Closes the Connection and provides the reason description. This method is similar to Connection.terminateSilently(), but additionally provides the reason why the Connection will be closed.
    
    Specified by:
    
    terminateWithReason in interface Closeable
    
    Specified by:
    
    terminateWithReason in interface Connection<SocketAddress>
    
    Parameters:
    
    reason - reason why terminated. This will be thrown is Closeable.isOpen() is called subsequently
  - close
```
public GrizzlyFuture<Closeable> close()
```
    Description copied from interface: Connection
    
    Gracefully close the Connection
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface Connection<SocketAddress>
    
    Returns:
    
    Future, which could be checked in case, if close operation will be run asynchronously
    
    See Also:
    
    which is not asynchronous
  - close
```
@Deprecated
public void close(CompletionHandler<Closeable> completionHandler)
```
    Deprecated. please use close() with the following GrizzlyFuture.addCompletionHandler(org.glassfish.grizzly.CompletionHandler) call
    
    Gracefully close the Connection
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface Connection<SocketAddress>
    
    Parameters:
    
    completionHandler - CompletionHandler to be called, when the connection is closed.
  - closeSilently
```
public final void closeSilently()
```
    Description copied from interface: Connection
    
    Gracefully close the Connection silently, no notification required on completion or failure.
    
    Specified by:
    
    closeSilently in interface Closeable
    
    Specified by:
    
    closeSilently in interface Connection<SocketAddress>
  - closeWithReason
```
public void closeWithReason(IOException reason)
```
    Description copied from interface: Connection
    
    Gracefully closes the Connection and provides the reason description. This method is similar to Connection.closeSilently(), but additionally provides the reason why the Connection will be closed.
    
    Specified by:
    
    closeWithReason in interface Closeable
    
    Specified by:
    
    closeWithReason in interface Connection<SocketAddress>
    
    Parameters:
    
    reason - reason why closed, this will be thrown by Closeable.isOpen() if called subsequently
  - closeFuture
```
public GrizzlyFuture<CloseReason> closeFuture()
```
    Specified by:
    
    closeFuture in interface Closeable
    
    Returns:
    
    the Future, that will be notified once this Closeable is closed
  - closeGracefully0
```
protected void closeGracefully0(CompletionHandler<Closeable> completionHandler,
                                CloseReason closeReason)
```
  - terminate0
```
protected void terminate0(CompletionHandler<Closeable> completionHandler,
                          CloseReason reason)
```
  - doClose
```
protected void doClose()
                throws IOException
```
    Do the actual connection close.
    
    Throws:
    
    IOException
  - addCloseListener
```
public void addCloseListener(CloseListener closeListener)
```
    Add the Connection.CloseListener, which will be notified once Connection will be closed.
    
    Specified by:
    
    addCloseListener in interface Closeable
    
    Specified by:
    
    addCloseListener in interface Connection<SocketAddress>
    
    Parameters:
    
    closeListener - Connection.CloseListener.
  - removeCloseListener
```
public boolean removeCloseListener(CloseListener closeListener)
```
    Remove the Connection.CloseListener.
    
    Specified by:
    
    removeCloseListener in interface Closeable
    
    Specified by:
    
    removeCloseListener in interface Connection<SocketAddress>
    
    Parameters:
    
    closeListener - Connection.CloseListener.
    
    Returns:
    
    true if the listener was successfully removed, or false otherwise.
  - addCloseListener
```
public void addCloseListener(Connection.CloseListener closeListener)
```
    Description copied from interface: Connection
    
    Add the Connection.CloseListener, which will be notified once Connection will be closed.
    
    Specified by:
    
    addCloseListener in interface Connection<SocketAddress>
    
    Parameters:
    
    closeListener - Connection.CloseListener
  - removeCloseListener
```
public boolean removeCloseListener(Connection.CloseListener closeListener)
```
    Description copied from interface: Connection
    
    Remove the Connection.CloseListener.
    
    Specified by:
    
    removeCloseListener in interface Connection<SocketAddress>
    
    Parameters:
    
    closeListener - Connection.CloseListener.
    
    Returns:
    
    true if listener successfully removed
  - notifyConnectionError
```
public void notifyConnectionError(Throwable error)
```
    Method gets invoked, when error occur during the Connection lifecycle.
    
    Specified by:
    
    notifyConnectionError in interface Connection<SocketAddress>
    
    Parameters:
    
    error - Throwable.
  - getMonitoringConfig
```
public final MonitoringConfig<ConnectionProbe> getMonitoringConfig()
```
    Return the object associated MonitoringConfig.
    
    Specified by:
    
    getMonitoringConfig in interface Connection<SocketAddress>
    
    Specified by:
    
    getMonitoringConfig in interface MonitoringAware<ConnectionProbe>
    
    Returns:
    
    the Connection monitoring configuration MonitoringConfig.
  - notifyProbesBind
```
protected static void notifyProbesBind(NIOConnection connection)
```
    Notify registered ConnectionProbes about the bind event.
    
    Parameters:
    
    connection - the Connection event occurred on.
  - notifyProbesAccept
```
protected static void notifyProbesAccept(NIOConnection serverConnection,
                                         NIOConnection clientConnection)
```
    Notify registered ConnectionProbes about the accept event.
    
    Parameters:
    
    serverConnection - the server Connection, which accepted the client connection.
    
    clientConnection - the client Connection.
  - notifyProbesConnect
```
protected static void notifyProbesConnect(NIOConnection connection)
```
    Notify registered ConnectionProbes about the connect event.
    
    Parameters:
    
    connection - the Connection event occurred on.
  - notifyProbesRead
```
protected static void notifyProbesRead(NIOConnection connection,
                                       Buffer data,
                                       int size)
```
    Notify registered ConnectionProbes about the read event.
  - notifyProbesWrite
```
protected static void notifyProbesWrite(NIOConnection connection,
                                        Buffer data,
                                        long size)
```
    Notify registered ConnectionProbes about the write event.
  - notifyIOEventReady
```
protected static void notifyIOEventReady(NIOConnection connection,
                                         IOEvent ioEvent)
```
    Notify registered ConnectionProbes about the IO Event ready event.
    
    Parameters:
    
    connection - the Connection event occurred on.
    
    ioEvent - the IOEvent.
  - notifyIOEventEnabled
```
protected static void notifyIOEventEnabled(NIOConnection connection,
                                           IOEvent ioEvent)
```
    Notify registered ConnectionProbes about the IO Event enabled event.
    
    Parameters:
    
    connection - the Connection event occurred on.
    
    ioEvent - the IOEvent.
  - notifyIOEventDisabled
```
protected static void notifyIOEventDisabled(NIOConnection connection,
                                            IOEvent ioEvent)
```
    Notify registered ConnectionProbes about the IO Event disabled event.
    
    Parameters:
    
    connection - the Connection event occurred on.
    
    ioEvent - the IOEvent.
  - notifyProbesClose
```
protected static void notifyProbesClose(NIOConnection connection)
```
    Notify registered ConnectionProbes about the close event.
    
    Parameters:
    
    connection - the Connection event occurred on.
  - notifyProbesError
```
protected static void notifyProbesError(NIOConnection connection,
                                        Throwable error)
```
    Notify registered ConnectionProbes about the error.
    
    Parameters:
    
    connection - the Connection event occurred on.
  - preClose
```
protected void preClose()
```
  - enableInitialOpRead
```
protected void enableInitialOpRead()
                            throws IOException
```
    Enables OP_READ if it has never been enabled before.
    
    Throws:
    
    IOException
  - simulateIOEvent
```
public void simulateIOEvent(IOEvent ioEvent)
                     throws IOException
```
    Specified by:
    
    simulateIOEvent in interface Connection<SocketAddress>
    
    Throws:
    
    IOException
  - enableIOEvent
```
public final void enableIOEvent(IOEvent ioEvent)
                         throws IOException
```
    Specified by:
    
    enableIOEvent in interface Connection<SocketAddress>
    
    Throws:
    
    IOException
  - disableIOEvent
```
public final void disableIOEvent(IOEvent ioEvent)
                          throws IOException
```
    Specified by:
    
    disableIOEvent in interface Connection<SocketAddress>
    
    Throws:
    
    IOException
  - checkEmptyRead
```
protected final void checkEmptyRead(int size)
```

Class NIOConnection

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.grizzly.Connection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.glassfish.grizzly.Connection

Methods inherited from interface org.glassfish.grizzly.OutputSink

Field Detail

NOTIFICATION_INITIALIZED

NOTIFICATION_CLOSED_COMPLETE

transport

maxAsyncWriteQueueSize

readTimeoutMillis

writeTimeoutMillis

channel

selectionKey

selectorRunner

processor

processorSelector

attributes

connectCloseSemaphoreUpdater

isBlocking

isStandalone

zeroByteReadCount

monitoringConfig

Constructor Detail

NIOConnection

Method Detail

configureBlocking

isBlocking

getMemoryManager

configureStandalone

isStandalone

getTransport

getMaxAsyncWriteQueueSize

setMaxAsyncWriteQueueSize

getReadTimeout

setReadTimeout

getWriteTimeout

setWriteTimeout

getSelectorRunner

setSelectorRunner

attachToSelectorRunner

detachSelectorRunner

getChannel

setChannel

getSelectionKey

setSelectionKey

obtainProcessor

getProcessor

setProcessor

getProcessorSelector

setProcessorSelector

obtainProcessorState

executeInEventThread

getAsyncReadQueue

getAsyncWriteQueue

getAttributes

read

read

write

write

write

write

write

isOpen

assertOpen

isClosed

getCloseReason

terminateSilently

terminate

terminateWithReason

close

close

closeSilently

closeWithReason

closeFuture

closeGracefully0