Module org.glassfish.grizzly

Package org.glassfish.grizzly

Interface Connection<L>

Type Parameters:

L - the Connection address type

All Superinterfaces:

AttributeStorage, Closeable, MonitoringAware<ConnectionProbe>, OutputSink, Readable<L>, Writeable<L>

All Known Implementing Classes:

NIOConnection, TCPNIOConnection, TCPNIOServerConnection, UDPNIOConnection, UDPNIOServerConnection

public interface Connection<L>
extends Readable<L>, Writeable<L>, Closeable, AttributeStorage, MonitoringAware<ConnectionProbe>

Common interface, which represents any kind of connection.

Author:

Alexey Stashok

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Connection.CloseListener	Deprecated. use CloseListener
static enum	Connection.CloseType	Deprecated. use CloseType

Method Summary

Modifier and Type	Method	Description
void	addCloseListener(CloseListener closeListener)	Add the Connection.CloseListener, which will be notified once Connection will be closed.
void	addCloseListener(Connection.CloseListener closeListener)	Deprecated. use addCloseListener(org.glassfish.grizzly.CloseListener)
void	assertOpen()	Checks if this Connection is open and ready to be used.
GrizzlyFuture<Closeable>	close()	Gracefully close the Connection
void	close(CompletionHandler<Closeable> completionHandler)	Deprecated. use close() with the following GrizzlyFuture.addCompletionHandler(org.glassfish.grizzly.CompletionHandler).
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)	Deprecated.
void	disableIOEvent(IOEvent ioEvent)
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.
CloseReason	getCloseReason()	Returns CloseReason if this Connection has been closed, or null otherwise.
long	getId()	Returns id of this instance, unique in the context of the JVM and the implementation class.
L	getLocalAddress()	Get the connection local address
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.
L	getPeerAddress()	Get the connection peer address
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.
int	getReadBufferSize()	Get the default size of Buffers, which will be allocated for reading data from Connection.
long	getReadTimeout(TimeUnit timeUnit)	Returns the current value for the blocking read timeout converted to the provided TimeUnit specification.
Transport	getTransport()	Get the Transport, to which this Connection belongs to.
int	getWriteBufferSize()	Get the default size of Buffers, which will be allocated for writing data to Connection.
long	getWriteTimeout(TimeUnit timeUnit)	Returns the current value for the blocking write timeout converted to the provided TimeUnit specification.
boolean	isBlocking()
boolean	isOpen()	Is Connection open and ready.
boolean	isStandalone()	Deprecated.
void	notifyConnectionError(Throwable error)	Method gets invoked, when error occur during the Connection lifecycle.
Processor	obtainProcessor(IOEvent ioEvent)	Gets the Processor, which will process Connection I/O event.
<E> E	obtainProcessorState(Processor processor, Supplier<E> factory)	Returns the Processor state associated with this Connection.
boolean	removeCloseListener(CloseListener closeListener)	Remove the Connection.CloseListener.
boolean	removeCloseListener(Connection.CloseListener closeListener)	Deprecated. use removeCloseListener(org.glassfish.grizzly.CloseListener)
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	setReadBufferSize(int readBufferSize)	Set the default size of Buffers, which will be allocated for reading data from Connection.
void	setReadTimeout(long timeout, TimeUnit timeUnit)	Specifies the timeout for the blocking reads.
void	setWriteBufferSize(int writeBufferSize)	Set the default size of Buffers, which will be allocated for writing data to Connection.
void	setWriteTimeout(long timeout, TimeUnit timeUnit)	Specifies the timeout for the blocking writes.
void	simulateIOEvent(IOEvent ioEvent)
GrizzlyFuture<Closeable>	terminate()	Close the Connection
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.

Methods inherited from interface org.glassfish.grizzly.attributes.AttributeStorage

getAttributes

Methods inherited from interface org.glassfish.grizzly.Closeable

closeFuture

Methods inherited from interface org.glassfish.grizzly.OutputSink

canWrite, canWrite, notifyCanWrite, notifyCanWrite

Methods inherited from interface org.glassfish.grizzly.Readable

read, read

Methods inherited from interface org.glassfish.grizzly.Writeable

write, write, write, write, write

Method Details

getId

long getId()

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

Returns:

id of this instance, never null.

getTransport

Transport getTransport()

Get the Transport, to which this Connection belongs to.

Returns:

the Transport, to which this Connection belongs to.

isOpen

boolean isOpen()

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

Specified by:

isOpen in interface Closeable

Returns:

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

assertOpen

void assertOpen()
         throws IOException

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

Throws:

IOException - giving the reason why this Closeable was closed.

getCloseReason

CloseReason getCloseReason()

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

Returns:

CloseReason if this Connection has been closed, or null otherwise

configureBlocking

void configureBlocking(boolean isBlocking)

Sets the Connection mode.

Parameters:

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

isBlocking

boolean isBlocking()

Returns:

the Connection mode. true, if Connection is operating in blocking mode, or false otherwise.

configureStandalone

@Deprecated
void configureStandalone(boolean isStandalone)

Deprecated.

isStandalone

@Deprecated
boolean isStandalone()

Deprecated.

obtainProcessor

Processor 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 - event to obtain the processor for

Returns:

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

getProcessor

Processor 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:

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

setProcessor

void setProcessor(Processor 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 - the default Processor, which will process Connection I/O events.

getProcessorSelector

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:

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

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

<E> E obtainProcessorState(Processor processor,
 Supplier<E> factory)

Returns the Processor state associated with this Connection.

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

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 - event to get the thread pool from

runnable - Runnable to run in the thread

getMemoryManager

MemoryManager<?> getMemoryManager()

Returns:

an associated MemoryManager. It's a shortcut for getTransport().getMemoryManager()

Since:

2.3.18

getPeerAddress

L getPeerAddress()

Get the connection peer address

Returns:

the connection peer address

getLocalAddress

L getLocalAddress()

Get the connection local address

Returns:

the connection local address

getReadBufferSize

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:

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

setReadBufferSize

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 - the default size of Buffers, which will be allocated for reading data from Connection.

getWriteBufferSize

int getWriteBufferSize()

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

Returns:

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

setWriteBufferSize

void setWriteBufferSize(int writeBufferSize)

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

Parameters:

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

getMaxAsyncWriteQueueSize

int getMaxAsyncWriteQueueSize()

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

Returns:

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

Since:

2.2

setMaxAsyncWriteQueueSize

void setMaxAsyncWriteQueueSize(int maxAsyncWriteQueueSize)

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

Parameters:

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

Since:

2.2

getReadTimeout

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 - the TimeUnit to convert the returned result to.

Returns:

the read timeout value

Since:

2.3

setReadTimeout

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 - the new timeout value

timeUnit - the TimeUnit specification of the provided value.

Since:

2.3

See Also:

• setReadTimeout(long, java.util.concurrent.TimeUnit)

getWriteTimeout

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 - the TimeUnit to convert the returned result to.

Returns:

the write timeout value

Since:

2.3

setWriteTimeout

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 - the new timeout value

timeUnit - the TimeUnit specification of the provided value.

Since:

2.3

See Also:

• setWriteTimeout(long, java.util.concurrent.TimeUnit)

simulateIOEvent

void simulateIOEvent(IOEvent ioEvent)
              throws IOException

Throws:

IOException

enableIOEvent

void enableIOEvent(IOEvent ioEvent)
            throws IOException

Throws:

IOException

disableIOEvent

void disableIOEvent(IOEvent ioEvent)
             throws IOException

Throws:

IOException

getMonitoringConfig

MonitoringConfig<ConnectionProbe> getMonitoringConfig()

Description copied from interface: MonitoringAware

Return the object associated MonitoringConfig.

Specified by:

getMonitoringConfig in interface MonitoringAware<L>

Returns:

the Connection monitoring configuration MonitoringConfig.

terminateSilently

void terminateSilently()

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

Specified by:

terminateSilently in interface Closeable

terminate

GrizzlyFuture<Closeable> terminate()

Close the Connection

Specified by:

terminate in interface Closeable

Returns:

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

terminateWithReason

void terminateWithReason(IOException reason)

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.

Specified by:

terminateWithReason in interface Closeable

Parameters:

reason - reason why terminated. This will be thrown is Closeable.isOpen() is called subsequently

close

GrizzlyFuture<Closeable> close()

Gracefully close the Connection

Specified by:

close in interface Closeable

Returns:

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

See Also:

• which is not asynchronous

close

@Deprecated
void close(CompletionHandler<Closeable> completionHandler)

Deprecated.

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

Gracefully close the Connection

Specified by:

close in interface Closeable

Parameters:

completionHandler - CompletionHandler to be called, when the connection is closed.

closeSilently

void closeSilently()

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

Specified by:

closeSilently in interface Closeable

closeWithReason

void closeWithReason(IOException reason)

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.

Specified by:

closeWithReason in interface Closeable

Parameters:

reason - reason why closed, this will be thrown by Closeable.isOpen() if called subsequently

addCloseListener

void addCloseListener(CloseListener closeListener)

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

Specified by:

addCloseListener in interface Closeable

Parameters:

closeListener - Connection.CloseListener.

Since:

2.3

removeCloseListener

boolean removeCloseListener(CloseListener closeListener)

Remove the Connection.CloseListener.

Specified by:

removeCloseListener in interface Closeable

Parameters:

closeListener - Connection.CloseListener.

Returns:

true if the listener was successfully removed, or false otherwise.

Since:

2.3

addCloseListener

@Deprecated
void addCloseListener(Connection.CloseListener closeListener)

Deprecated.

use addCloseListener(org.glassfish.grizzly.CloseListener)

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

Parameters:

closeListener - Connection.CloseListener

removeCloseListener

@Deprecated
boolean removeCloseListener(Connection.CloseListener closeListener)

Deprecated.

use removeCloseListener(org.glassfish.grizzly.CloseListener)

Remove the Connection.CloseListener.

Parameters:

closeListener - Connection.CloseListener.

Returns:

true if listener successfully removed

notifyConnectionError

void notifyConnectionError(Throwable error)

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

Parameters:

error - Throwable.