Grizzly NIO 5.0.2 · org.glassfish.grizzly.Connection

Modifier and Type	Class and Description
public static interface	Connection.CloseListener Deprecated use `org.glassfish.grizzly.CloseListener` This interface will be removed in 3.0.
public static enum	Connection.CloseType Deprecated use `org.glassfish.grizzly.CloseType` This enum will be removed in 3.0.

Method Summary

Modifier and Type	Method and Description
public void	addCloseListener(CloseListener<T extends Closeable, C extends ICloseType> `CloseListener`. closeListener) Redeclares org.glassfish.grizzly.Closeable.addCloseListener. Add the `CloseListener`, which will be notified once `Connection` will be closed.
public void	addCloseListener(Connection.CloseListener `CloseListener` closeListener) Deprecated use `addCloseListener(org.glassfish.grizzly.CloseListener)` Add the `CloseListener`, which will be notified once `Connection` will be closed.
public void	assertOpen() Redeclares org.glassfish.grizzly.Closeable.assertOpen. Checks if this `Connection` is open and ready to be used.
public GrizzlyFuture<Closeable>	Returns: `Future`, which could be checked in case, if close operation will be run asynchronously close() Redeclares org.glassfish.grizzly.Closeable.close. Gracefully close the `Connection`
public void	close(CompletionHandler<Closeable> `CompletionHandler` to be called, when the connection is closed. completionHandler) Redeclares org.glassfish.grizzly.Closeable.close. Deprecated use `close()` with the following `GrizzlyFuture#addCompletionHandler(org.glassfish.grizzly.CompletionHandler)`. Gracefully close the `Connection`
public void	closeSilently() Redeclares org.glassfish.grizzly.Closeable.closeSilently. Gracefully close the `Connection` silently, no notification required on completion or failure.
public void	closeWithReason(IOException reason) Redeclares org.glassfish.grizzly.Closeable.closeWithReason. Gracefully closes the `Connection` and provides the reason description.
public void	configureBlocking(boolean the `Connection` mode. `true`, if `Connection` should operate in blocking mode, or `false` otherwise. isBlocking) Sets the `Connection` mode.
public void	configureStandalone(boolean isStandalone) Deprecated
public void	disableIOEvent(final IOEvent ioEvent)
public void	enableIOEvent(final IOEvent ioEvent)
public void	executeInEventThread(IOEvent event to get the thread pool from event, Runnable Runnable to run in the thread runnable) Executes the `Runnable` in the thread, responsible for running the given type of event on this `Connection`.
public CloseReason	Returns: `CloseReason` if this `Connection` has been closed, or `null` otherwise getCloseReason() Returns `CloseReason` if this `Connection` has been closed, or `null` otherwise.
public long	Returns: id of this instance, never null. getId() Returns id of this instance, unique in the context of the JVM and the implementation class.
public L	Returns: the connection local address getLocalAddress() Get the connection local address
public int	Returns: the max size (in bytes) of asynchronous write queue associated with connection. getMaxAsyncWriteQueueSize() Get the max size (in bytes) of asynchronous write queue associated with connection.
public MemoryManager<?>	getMemoryManager() Returns: an associated `MemoryManager`.
public MonitoringConfig<ConnectionProbe>	Returns: the `Connection` monitoring configuration `MonitoringConfig`. getMonitoringConfig() Redeclares org.glassfish.grizzly.monitoring.MonitoringAware.getMonitoringConfig. Return the object associated `MonitoringConfig`.
public L	Returns: the connection peer address getPeerAddress() Get the connection peer address
public Processor<E extends Context>	Returns: the default `Processor`, which will process `Connection` I/O events. getProcessor() Gets the default `Processor`, which will process `Connection` I/O events.
public ProcessorSelector	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`. 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`.
public int	Returns: the default size of `Buffer`s, which will be allocated for reading data from `Connection`. getReadBufferSize() Get the default size of `Buffer`s, which will be allocated for reading data from `Connection`.
public long	Returns: the read timeout value getReadTimeout(TimeUnit the `TimeUnit` to convert the returned result to. timeUnit) Returns the current value for the blocking read timeout converted to the provided `TimeUnit` specification.
public Transport	Returns: the `Transport`, to which this `Connection` belongs to. getTransport() Get the `Transport`, to which this `Connection` belongs to.
public int	Returns: the default size of `Buffer`s, which will be allocated for writing data to `Connection`. getWriteBufferSize() Get the default size of `Buffer`s, which will be allocated for writing data to `Connection`.
public long	Returns: the write timeout value getWriteTimeout(TimeUnit the `TimeUnit` to convert the returned result to. timeUnit) Returns the current value for the blocking write timeout converted to the provided `TimeUnit` specification.
public boolean	isBlocking() Returns: the `Connection` mode.
public boolean	Returns: `true`, if connection is open and ready, or `false` otherwise. isOpen() Redeclares org.glassfish.grizzly.Closeable.isOpen. Is `Connection` open and ready.
public boolean	isStandalone() Deprecated
public void	notifyConnectionError(Throwable `Throwable`. error) Method gets invoked, when error occur during the `Connection` lifecycle.
public Processor<E extends Context>	Returns: the default `Processor`, which will process `Connection` I/O events. obtainProcessor(IOEvent event to obtain the processor for ioEvent) Gets the `Processor`, which will process `Connection` I/O event.
public < state of the `Processor` E> E	Returns: the `Processor` state associated with this `Connection`. obtainProcessorState(Processor<E extends Context> `Processor` processor, Supplier<E> factory that is used to initialise the state factory) Returns the `Processor` state associated with this `Connection`.
public boolean	removeCloseListener(CloseListener<T extends Closeable, C extends ICloseType> `CloseListener`. closeListener) Redeclares org.glassfish.grizzly.Closeable.removeCloseListener. Remove the `CloseListener`.
public boolean	Returns: true if listener successfully removed removeCloseListener(Connection.CloseListener `CloseListener`. closeListener) Deprecated use `removeCloseListener(org.glassfish.grizzly.CloseListener)` Remove the `CloseListener`.
public void	setMaxAsyncWriteQueueSize(int the max size (in bytes) of asynchronous write queue associated with connection. maxAsyncWriteQueueSize) Set the max size (in bytes) of asynchronous write queue associated with connection.
public void	setProcessor(Processor<E extends Context> the default `Processor`, which will process `Connection` I/O events. preferableProcessor) Sets the default `Processor`, which will process `Connection` I/O events.
public void	setProcessorSelector(ProcessorSelector 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`. 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`.
public void	setReadBufferSize(int the default size of `Buffer`s, which will be allocated for reading data from `Connection`. readBufferSize) Set the default size of `Buffer`s, which will be allocated for reading data from `Connection`.
public void	setReadTimeout(long the new timeout value timeout, TimeUnit the `TimeUnit` specification of the provided value. timeUnit) Specifies the timeout for the blocking reads.
public void	setWriteBufferSize(int the default size of `Buffer`s, which will be allocated for writing data to `Connection`. writeBufferSize) Set the default size of `Buffer`s, which will be allocated for writing data to `Connection`.
public void	setWriteTimeout(long the new timeout value timeout, TimeUnit the `TimeUnit` specification of the provided value. timeUnit) Specifies the timeout for the blocking writes.
public void	simulateIOEvent(final IOEvent ioEvent)
public GrizzlyFuture<Closeable>	Returns: `Future`, which could be checked in case, if close operation will be run asynchronously terminate() Redeclares org.glassfish.grizzly.Closeable.terminate. Close the `Connection`
public void	terminateSilently() Redeclares org.glassfish.grizzly.Closeable.terminateSilently. Close the `Connection` silently, no notification required on completion or failure.
public void	terminateWithReason(IOException reason) Redeclares org.glassfish.grizzly.Closeable.terminateWithReason. Closes the `Connection` and provides the reason description.

Inherited from org.glassfish.grizzly.attributes.AttributeStorage:: getAttributes
Inherited from org.glassfish.grizzly.Closeable:: closeFuture
Inherited from org.glassfish.grizzly.Readable:: read read
Inherited from org.glassfish.grizzly.Writeable:: write write write write write

Method Detail

addCloseListener back to summary

addCloseListener	back to summary
public void addCloseListener(CloseListener<T extends Closeable, C extends ICloseType> closeListener) Redeclares org.glassfish.grizzly.Closeable.addCloseListener. Add the `CloseListener`, which will be notified once `Connection` will be closed. Parameters closeListener:CloseListener<T extends Closeable, C extends ICloseType> `CloseListener`. Annotations @Override Since 2.3

public void addCloseListener(CloseListener<T extends Closeable, C extends ICloseType> closeListener)

Redeclares org.glassfish.grizzly.Closeable.addCloseListener.

Add the CloseListener, which will be notified once Connection will be closed.

Parameters

closeListener:CloseListener<T extends Closeable, C extends ICloseType>: CloseListener.

Annotations

@Override

Since

2.3

addCloseListener back to summary

addCloseListener	back to summary
public void addCloseListener(Connection.CloseListener closeListener) Deprecated use `addCloseListener(org.glassfish.grizzly.CloseListener)` Add the `CloseListener`, which will be notified once `Connection` will be closed. Parameters closeListener:Connection.CloseListener `CloseListener` Annotations @Deprecated

public void addCloseListener(Connection.CloseListener closeListener)

Deprecated

use addCloseListener(org.glassfish.grizzly.CloseListener)

Add the CloseListener, which will be notified once Connection will be closed.

Parameters

closeListener:Connection.CloseListener: CloseListener

Annotations

@Deprecated

assertOpen back to summary

assertOpen	back to summary
public void assertOpen() throws IOException Redeclares org.glassfish.grizzly.Closeable.assertOpen. 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. Annotations @Override Exceptions IOException: Doc from org.glassfish.grizzly.Closeable.assertOpen. giving the reason why this `Closeable` was closed.

public void assertOpen() throws IOException

Redeclares org.glassfish.grizzly.Closeable.assertOpen.

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.

Annotations

@Override

Exceptions

IOException:

Doc from org.glassfish.grizzly.Closeable.assertOpen.

giving the reason why this Closeable was closed.

close back to summary

close	back to summary
public GrizzlyFuture<Closeable> close() Redeclares org.glassfish.grizzly.Closeable.close. Gracefully close the `Connection` Returns:GrizzlyFuture<Closeable> `Future`, which could be checked in case, if close operation will be run asynchronously Annotations @Override

public GrizzlyFuture<Closeable> close()

Redeclares org.glassfish.grizzly.Closeable.close.

Gracefully close the Connection

Returns:GrizzlyFuture<Closeable>

Future, which could be checked in case, if close operation will be run asynchronously

Annotations

@Override

close back to summary

close	back to summary
public void close(CompletionHandler<Closeable> completionHandler) Redeclares org.glassfish.grizzly.Closeable.close. Deprecated use `close()` with the following `GrizzlyFuture#addCompletionHandler(org.glassfish.grizzly.CompletionHandler)`. Gracefully close the `Connection` Parameters completionHandler:CompletionHandler<Closeable> `CompletionHandler` to be called, when the connection is closed. Annotations @Deprecated @Override

public void close(CompletionHandler<Closeable> completionHandler)

Redeclares org.glassfish.grizzly.Closeable.close.

Deprecated

use close() with the following GrizzlyFuture#addCompletionHandler(org.glassfish.grizzly.CompletionHandler).

Gracefully close the Connection

Parameters

completionHandler:CompletionHandler<Closeable>: CompletionHandler to be called, when the connection is closed.

Annotations

@Deprecated
@Override

closeSilently back to summary

closeSilently	back to summary
public void closeSilently() Redeclares org.glassfish.grizzly.Closeable.closeSilently. Gracefully close the `Connection` silently, no notification required on completion or failure. Annotations @Override

public void closeSilently()

Redeclares org.glassfish.grizzly.Closeable.closeSilently.

Gracefully close the Connection silently, no notification required on completion or failure.

Annotations

@Override

closeWithReason back to summary

closeWithReason	back to summary
public void closeWithReason(IOException reason) Redeclares org.glassfish.grizzly.Closeable.closeWithReason. Gracefully closes the `Connection` and provides the reason description. This method is similar to `closeSilently()`, but additionally provides the reason why the `Connection` will be closed. Annotations @Override

public void closeWithReason(IOException reason)

Redeclares org.glassfish.grizzly.Closeable.closeWithReason.

Gracefully closes the Connection and provides the reason description. This method is similar to closeSilently(), but additionally provides the reason why the Connection will be closed.

Annotations

@Override

configureBlocking back to summary

configureBlocking	back to summary
public void configureBlocking(boolean isBlocking) Sets the `Connection` mode. Parameters isBlocking:boolean the `Connection` mode. `true`, if `Connection` should operate in blocking mode, or `false` otherwise.

public void configureBlocking(boolean isBlocking)

Sets the Connection mode.

Parameters

isBlocking:boolean: the Connection mode. true, if Connection should operate in blocking mode, or false otherwise.

configureStandalone	back to summary
public void configureStandalone(boolean isStandalone) Deprecated Annotations @Deprecated

disableIOEvent	back to summary
public void disableIOEvent(final IOEvent ioEvent) throws IOException

enableIOEvent	back to summary
public void enableIOEvent(final IOEvent ioEvent) throws IOException

executeInEventThread back to summary

executeInEventThread	back to summary
public void executeInEventThread(IOEvent event, Runnable runnable) 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. Parameters event:IOEvent event to get the thread pool from runnable:Runnable Runnable to run in the thread

public void executeInEventThread(IOEvent event, Runnable runnable)

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.

Parameters

event:IOEvent: event to get the thread pool from
runnable:Runnable: Runnable to run in the thread

getCloseReason back to summary

getCloseReason	back to summary
public CloseReason getCloseReason() Returns `CloseReason` if this `Connection` has been closed, or `null` otherwise. Returns:CloseReason `CloseReason` if this `Connection` has been closed, or `null` otherwise

public CloseReason getCloseReason()

Returns CloseReason if this Connection has been closed, or null otherwise.

Returns:CloseReason: CloseReason if this Connection has been closed, or null otherwise

getId	back to summary
public long getId() Returns id of this instance, unique in the context of the JVM and the implementation class. Returns:long id of this instance, never null.

getId

back to summary

public long getId()

Returns id of this instance, unique in the context of the JVM and the implementation class.

Returns:long: id of this instance, never null.

getLocalAddress	back to summary
public L getLocalAddress() Get the connection local address Returns:L the connection local address

getLocalAddress

back to summary

public L getLocalAddress()

Get the connection local address

Returns:L: the connection local address

getMaxAsyncWriteQueueSize	back to summary
public int getMaxAsyncWriteQueueSize() Get the max size (in bytes) of asynchronous write queue associated with connection. Returns:int the max size (in bytes) of asynchronous write queue associated with connection. Since 2.2

getMaxAsyncWriteQueueSize

back to summary

public int getMaxAsyncWriteQueueSize()

Get the max size (in bytes) of asynchronous write queue associated with connection.

Returns:int: the max size (in bytes) of asynchronous write queue associated with connection.
Since: 2.2

getMemoryManager	back to summary
public MemoryManager<?> getMemoryManager() Returns:MemoryManager<?> an associated `MemoryManager`. It's a shortcut for `getTransport().getMemoryManager()` Since 2.3.18

getMonitoringConfig back to summary

getMonitoringConfig	back to summary
public MonitoringConfig<ConnectionProbe> getMonitoringConfig() Redeclares org.glassfish.grizzly.monitoring.MonitoringAware.getMonitoringConfig. Doc from org.glassfish.grizzly.monitoring.MonitoringAware.getMonitoringConfig. Return the object associated `MonitoringConfig`. Returns:MonitoringConfig<ConnectionProbe> the `Connection` monitoring configuration `MonitoringConfig`. Annotations @Override

public MonitoringConfig<ConnectionProbe> getMonitoringConfig()

Redeclares org.glassfish.grizzly.monitoring.MonitoringAware.getMonitoringConfig.

Doc from org.glassfish.grizzly.monitoring.MonitoringAware.getMonitoringConfig.

Return the object associated MonitoringConfig.

Returns:MonitoringConfig<ConnectionProbe>

the Connection monitoring configuration MonitoringConfig.

Annotations

@Override

getPeerAddress	back to summary
public L getPeerAddress() Get the connection peer address Returns:L the connection peer address

getPeerAddress

back to summary

public L getPeerAddress()

Get the connection peer address

Returns:L: the connection peer address

getProcessor back to summary

getProcessor	back to summary
public Processor<E extends Context> getProcessor() 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. Returns:Processor<E extends Context> the default `Processor`, which will process `Connection` I/O events.

public Processor<E extends Context> getProcessor()

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.

Returns:Processor<E extends Context>: the default Processor, which will process Connection I/O events.

getProcessorSelector back to summary

getProcessorSelector	back to summary
public 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`. Returns:ProcessorSelector 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`.

public 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.

Returns:ProcessorSelector: 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.

getReadBufferSize back to summary

getReadBufferSize	back to summary
public int getReadBufferSize() Get the default size of `Buffer`s, which will be allocated for reading data from `Connection`. The value less or equal to zero will be ignored. Returns:int the default size of `Buffer`s, which will be allocated for reading data from `Connection`.

public int getReadBufferSize()

Get the default size of Buffers, which will be allocated for reading data from Connection. The value less or equal to zero will be ignored.

Returns:int: the default size of Buffers, which will be allocated for reading data from Connection.

getReadTimeout back to summary

getReadTimeout	back to summary
public long getReadTimeout(TimeUnit timeUnit) 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. Parameters timeUnit:TimeUnit the `TimeUnit` to convert the returned result to. Returns:long the read timeout value Since 2.3

public long getReadTimeout(TimeUnit timeUnit)

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.

Parameters

timeUnit:TimeUnit: the TimeUnit to convert the returned result to.

Returns:long

the read timeout value

Since

2.3

getTransport back to summary

getTransport	back to summary
public Transport getTransport() Get the `Transport`, to which this `Connection` belongs to. Returns:Transport the `Transport`, to which this `Connection` belongs to.

public Transport getTransport()

Get the Transport, to which this Connection belongs to.

Returns:Transport: the Transport, to which this Connection belongs to.

getWriteBufferSize back to summary

getWriteBufferSize	back to summary
public int getWriteBufferSize() Get the default size of `Buffer`s, which will be allocated for writing data to `Connection`. Returns:int the default size of `Buffer`s, which will be allocated for writing data to `Connection`.

public int getWriteBufferSize()

Get the default size of Buffers, which will be allocated for writing data to Connection.

Returns:int: the default size of Buffers, which will be allocated for writing data to Connection.

getWriteTimeout back to summary

getWriteTimeout	back to summary
public long getWriteTimeout(TimeUnit timeUnit) 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. Parameters timeUnit:TimeUnit the `TimeUnit` to convert the returned result to. Returns:long the write timeout value Since 2.3

public long getWriteTimeout(TimeUnit timeUnit)

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.

Parameters

timeUnit:TimeUnit: the TimeUnit to convert the returned result to.

Returns:long

the write timeout value

Since

2.3

isBlocking	back to summary
public boolean isBlocking() Returns:boolean the `Connection` mode. `true`, if `Connection` is operating in blocking mode, or `false` otherwise.

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Redeclares org.glassfish.grizzly.Closeable.isOpen. Is `Connection` open and ready. Returns `true`, if connection is open and ready, or `false` otherwise. Returns:boolean `true`, if connection is open and ready, or `false` otherwise. Annotations @Override

public boolean isOpen()

Redeclares org.glassfish.grizzly.Closeable.isOpen.

Is Connection open and ready. Returns true, if connection is open and ready, or false otherwise.

Returns:boolean

true, if connection is open and ready, or false otherwise.

Annotations

@Override

isStandalone	back to summary
public boolean isStandalone() Deprecated Annotations @Deprecated

notifyConnectionError back to summary

notifyConnectionError	back to summary
public void notifyConnectionError(Throwable error) Method gets invoked, when error occur during the `Connection` lifecycle. Parameters error:Throwable `Throwable`.

public void notifyConnectionError(Throwable error)

Method gets invoked, when error occur during the Connection lifecycle.

Parameters

error:Throwable: Throwable.

obtainProcessor back to summary

obtainProcessor	back to summary
public Processor<E extends Context> obtainProcessor(IOEvent ioEvent) 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`. Parameters ioEvent:IOEvent event to obtain the processor for Returns:Processor<E extends Context> the default `Processor`, which will process `Connection` I/O events.

public Processor<E extends Context> obtainProcessor(IOEvent ioEvent)

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.

Parameters

ioEvent:IOEvent: event to obtain the processor for

Returns:Processor<E extends Context>

the default Processor, which will process Connection I/O events.

obtainProcessorState back to summary

obtainProcessorState	back to summary
public <E> E obtainProcessorState(Processor<E extends Context> processor, Supplier<E> factory) Returns the `Processor` state associated with this `Connection`. Parameters <E> state of the `Processor` processor:Processor<E extends Context> `Processor` factory:Supplier<E> factory that is used to initialise the state Returns:E the `Processor` state associated with this `Connection`.

public <E> E obtainProcessorState(Processor<E extends Context> processor, Supplier<E> factory)

Returns the Processor state associated with this Connection.

Parameters

<E>: state of the Processor
processor:Processor<E extends Context>: Processor
factory:Supplier<E>: factory that is used to initialise the state

Returns:E

the Processor state associated with this Connection.

removeCloseListener back to summary

removeCloseListener	back to summary
public boolean removeCloseListener(CloseListener<T extends Closeable, C extends ICloseType> closeListener) Redeclares org.glassfish.grizzly.Closeable.removeCloseListener. Remove the `CloseListener`. Parameters closeListener:CloseListener<T extends Closeable, C extends ICloseType> `CloseListener`. Annotations @Override Since 2.3

public boolean removeCloseListener(CloseListener<T extends Closeable, C extends ICloseType> closeListener)

Redeclares org.glassfish.grizzly.Closeable.removeCloseListener.

Remove the CloseListener.

Parameters

closeListener:CloseListener<T extends Closeable, C extends ICloseType>: CloseListener.

Annotations

@Override

Since

2.3

removeCloseListener back to summary

removeCloseListener	back to summary
public boolean removeCloseListener(Connection.CloseListener closeListener) Deprecated use `removeCloseListener(org.glassfish.grizzly.CloseListener)` Remove the `CloseListener`. Parameters closeListener:Connection.CloseListener `CloseListener`. Returns:boolean true if listener successfully removed Annotations @Deprecated

public boolean removeCloseListener(Connection.CloseListener closeListener)

Deprecated

use removeCloseListener(org.glassfish.grizzly.CloseListener)

Remove the CloseListener.

Parameters

closeListener:Connection.CloseListener: CloseListener.

Returns:boolean

true if listener successfully removed

Annotations

@Deprecated

setMaxAsyncWriteQueueSize	back to summary
public void setMaxAsyncWriteQueueSize(int maxAsyncWriteQueueSize) Set the max size (in bytes) of asynchronous write queue associated with connection. Parameters maxAsyncWriteQueueSize:int the max size (in bytes) of asynchronous write queue associated with connection. Since 2.2

setMaxAsyncWriteQueueSize

back to summary

public void setMaxAsyncWriteQueueSize(int maxAsyncWriteQueueSize)

Set the max size (in bytes) of asynchronous write queue associated with connection.

Parameters

maxAsyncWriteQueueSize:int: the max size (in bytes) of asynchronous write queue associated with connection.

Since

2.2

setProcessor back to summary

setProcessor	back to summary
public void setProcessor(Processor<E extends Context> preferableProcessor) 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. Parameters preferableProcessor:Processor<E extends Context> the default `Processor`, which will process `Connection` I/O events.

public void setProcessor(Processor<E extends Context> preferableProcessor)

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.

Parameters

preferableProcessor:Processor<E extends Context>: the default Processor, which will process Connection I/O events.

setProcessorSelector back to summary

setProcessorSelector	back to summary
public 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`. Parameters preferableProcessorSelector:ProcessorSelector 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`.

public 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.

Parameters

preferableProcessorSelector:ProcessorSelector: 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.

setReadBufferSize back to summary

setReadBufferSize	back to summary
public void setReadBufferSize(int readBufferSize) Set the default size of `Buffer`s, which will be allocated for reading data from `Connection`. The value less or equal to zero will be ignored. Parameters readBufferSize:int the default size of `Buffer`s, which will be allocated for reading data from `Connection`.

public void setReadBufferSize(int readBufferSize)

Set the default size of Buffers, which will be allocated for reading data from Connection. The value less or equal to zero will be ignored.

Parameters

readBufferSize:int: the default size of Buffers, which will be allocated for reading data from Connection.

setReadTimeout back to summary

setReadTimeout	back to summary
public void setReadTimeout(long timeout, TimeUnit timeUnit) 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. Parameters timeout:long the new timeout value timeUnit:TimeUnit the `TimeUnit` specification of the provided value. Since 2.3 See Also `Connection#setReadTimeout(long, java.util.concurrent.TimeUnit)`

public void setReadTimeout(long timeout, TimeUnit timeUnit)

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.

Parameters

timeout:long: the new timeout value
timeUnit:TimeUnit: the TimeUnit specification of the provided value.

Since

2.3

setWriteBufferSize back to summary

setWriteBufferSize	back to summary
public void setWriteBufferSize(int writeBufferSize) Set the default size of `Buffer`s, which will be allocated for writing data to `Connection`. Parameters writeBufferSize:int the default size of `Buffer`s, which will be allocated for writing data to `Connection`.

public void setWriteBufferSize(int writeBufferSize)

Set the default size of Buffers, which will be allocated for writing data to Connection.

Parameters

writeBufferSize:int: the default size of Buffers, which will be allocated for writing data to Connection.

setWriteTimeout back to summary

setWriteTimeout	back to summary
public void setWriteTimeout(long timeout, TimeUnit timeUnit) 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. Parameters timeout:long the new timeout value timeUnit:TimeUnit the `TimeUnit` specification of the provided value. Since 2.3 See Also `Connection#setWriteTimeout(long, java.util.concurrent.TimeUnit)`

public void setWriteTimeout(long timeout, TimeUnit timeUnit)

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.

Parameters

timeout:long: the new timeout value
timeUnit:TimeUnit: the TimeUnit specification of the provided value.

Since

2.3

simulateIOEvent	back to summary
public void simulateIOEvent(final IOEvent ioEvent) throws IOException

terminate back to summary

terminate	back to summary
public GrizzlyFuture<Closeable> terminate() Redeclares org.glassfish.grizzly.Closeable.terminate. Close the `Connection` Returns:GrizzlyFuture<Closeable> `Future`, which could be checked in case, if close operation will be run asynchronously Annotations @Override

public GrizzlyFuture<Closeable> terminate()

Redeclares org.glassfish.grizzly.Closeable.terminate.

Close the Connection

Returns:GrizzlyFuture<Closeable>

Future, which could be checked in case, if close operation will be run asynchronously

Annotations

@Override

terminateSilently back to summary

terminateSilently	back to summary
public void terminateSilently() Redeclares org.glassfish.grizzly.Closeable.terminateSilently. Close the `Connection` silently, no notification required on completion or failure. Annotations @Override

public void terminateSilently()

Redeclares org.glassfish.grizzly.Closeable.terminateSilently.

Close the Connection silently, no notification required on completion or failure.

Annotations

@Override

terminateWithReason back to summary

terminateWithReason	back to summary
public void terminateWithReason(IOException reason) Redeclares org.glassfish.grizzly.Closeable.terminateWithReason. Closes the `Connection` and provides the reason description. This method is similar to `terminateSilently()`, but additionally provides the reason why the `Connection` will be closed. Annotations @Override

public void terminateWithReason(IOException reason)

Redeclares org.glassfish.grizzly.Closeable.terminateWithReason.

Closes the Connection and provides the reason description. This method is similar to terminateSilently(), but additionally provides the reason why the Connection will be closed.

Annotations

@Override

Modifier and Type	Field and Description
public static final Connection.CloseType	LOCALLY References Deprecated `Connection.CloseType` is deprecated or references (maybe indirectly) at least one deprecated element.
public static final Connection.CloseType	REMOTELY References Deprecated `Connection.CloseType` is deprecated or references (maybe indirectly) at least one deprecated element.

Modifier and Type	Method and Description
public static Connection.CloseType	valueOf(String name) References Deprecated `Connection.CloseType` is deprecated or references (maybe indirectly) at least one deprecated element.
public static Connection.CloseType[]	values() References Deprecated `Connection.CloseType` is deprecated or references (maybe indirectly) at least one deprecated element.

public Interface Connection<L>

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface Connection.CloseListener

Method Summary

Method Detail

public final Enum Connection.CloseType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail