Module org.glassfish.grizzly

Package org.glassfish.grizzly

Interface Transport

All Superinterfaces:

MonitoringAware<TransportProbe>

All Known Implementing Classes:

AbstractTransport, NIOTransport, TCPNIOTransport, UDPNIOTransport

public interface Transport
extends MonitoringAware<TransportProbe>

Transport interface describes the transport unit used in Grizzly. Transport implementation could operate over TCP, UDP or other custom protocol, using blocking, NIO or NIO.2 Java API.

Author:

Alexey Stashok

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Transport.State

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_READ_BUFFER_SIZE	The default read buffer size.
static final int	DEFAULT_READ_TIMEOUT	Default read timeout in seconds.
static final int	DEFAULT_WRITE_BUFFER_SIZE	The default write buffer size.
static final int	DEFAULT_WRITE_TIMEOUT	Default write timeout in seconds.

Method Summary

Modifier and Type	Method	Description
boolean	addShutdownListener(GracefulShutdownListener shutdownListener)	Adds a GracefulShutdownListener which will be called when shutdown() is called to enable graceful shutdown of transports.
void	configureBlocking(boolean isBlocking)	Sets the Transport mode.
void	configureStandalone(boolean isStandalone)
void	fireIOEvent(IOEvent ioEvent, Connection connection, IOEventLifeCycleListener listener)	Fires specific IOEvent on the Connection
AttributeBuilder	getAttributeBuilder()	Get Transport associated AttributeBuilder, which will be used by Transport and its Connections to store custom Attributes.
MonitoringConfig<ConnectionProbe>	getConnectionMonitoringConfig()	Get the monitoring configuration for Transport Connections.
IOStrategy	getIOStrategy()	Get the IOStrategy implementation, which will be used by Transport to process IOEvent.
ExecutorService	getKernelThreadPool()
ThreadPoolConfig	getKernelThreadPoolConfig()
MemoryManager	getMemoryManager()	Get the Transport associated MemoryManager, which will be used by the Transport, its Connections and by during processing I/O events, occurred on Connections.
MonitoringConfig<TransportProbe>	getMonitoringConfig()	Get the Transport monitoring configuration MonitoringConfig.
String	getName()	Gets the Transport name.
Processor	getProcessor()	Gets the default Processor, which will process Connection I/O events in case, if Connection doesn't have own Processor preferences.
ProcessorSelector	getProcessorSelector()	Gets the default ProcessorSelector, which will be used to get Processor to process Connection I/O events, in case if this Transport's Processor is null and Connection doesn't have neither preferred Processor nor ProcessorSelector.
int	getReadBufferSize()	Get the default size of Buffers, which will be allocated for reading data from Transport's Connections.
Reader	getReader(boolean isBlocking)	Get the Reader implementation, depending on the requested mode.
Reader	getReader(Connection connection)	Get the Reader to read data from the Connection.
long	getReadTimeout(TimeUnit timeUnit)	Returns the current value for the blocking read timeout converted to the provided TimeUnit specification.
StateHolder<Transport.State>	getState()	Return the Transport state controller.
MonitoringConfig<ThreadPoolProbe>	getThreadPoolMonitoringConfig()	Get the monitoring configuration for Transport thread pool.
ExecutorService	getWorkerThreadPool()	Get a thread pool, which will run IOEvent processing (depending on Transport IOStrategy) to let kernel threads continue their job.
ThreadPoolConfig	getWorkerThreadPoolConfig()
int	getWriteBufferSize()	Get the default size of Buffers, which will be allocated for writing data to Transport's Connections.
Writer	getWriter(boolean isBlocking)	Get the Writer implementation, depending on the requested mode.
Writer	getWriter(Connection connection)	Get the Writer to write data to the Connection.
long	getWriteTimeout(TimeUnit timeUnit)	Returns the current value for the blocking write timeout converted to the provided TimeUnit specification.
boolean	isBlocking()	Returns the Transport mode.
boolean	isPaused()
boolean	isStandalone()
boolean	isStopped()	Returns true, if this Transport is in stopped state, false otherwise.
void	notifyTransportError(Throwable error)	Method gets invoked, when error occur during the Transport lifecycle.
Processor	obtainProcessor(IOEvent ioEvent, Connection connection)	Gets the default Processor, which will process Transport Connections I/O events in case, if Connection doesn't have own Processor preferences.
void	pause()	Pauses the transport
void	resume()	Resumes the transport after a pause
void	setAttributeBuilder(AttributeBuilder attributeBuilder)	Set Transport associated AttributeBuilder, which will be used by Transport and its Connections to store custom Attributes.
void	setIOStrategy(IOStrategy IOStrategy)	Set the IOStrategy implementation, which will be used by Transport to process IOEvent.
void	setKernelThreadPool(ExecutorService threadPool)	Set a thread pool which will run Transport internal tasks.
void	setKernelThreadPoolConfig(ThreadPoolConfig kernelConfig)	Set the ThreadPoolConfig to be used by the Transport internal thread pool.
void	setMemoryManager(MemoryManager memoryManager)	Set the Transport associated MemoryManager, which will be used by the Transport, its Connections and by during processing I/O events, occurred on Connections.
void	setName(String name)	Sets the Transport name.
void	setProcessor(Processor processor)	Sets the default Processor, which will process Connection I/O events in case, if Connection doesn't have own Processor preferences.
void	setProcessorSelector(ProcessorSelector selector)	Sets the default ProcessorSelector, which will be used to get Processor to process Connection I/O events, in case if this Transport's Processor is null and Connection doesn't have neither preferred Processor nor ProcessorSelector.
void	setReadBufferSize(int readBufferSize)	Set the default size of Buffers, which will be allocated for reading data from Transport's Connections.
void	setReadTimeout(long timeout, TimeUnit timeUnit)	Specifies the timeout for the blocking reads.
void	setWorkerThreadPool(ExecutorService threadPool)	Set a thread pool, which will run IOEvent processing (depending on Transport IOStrategy) to let kernel threads continue their job.
void	setWorkerThreadPoolConfig(ThreadPoolConfig workerConfig)	Set the ThreadPoolConfig to be used by the worker thread pool.
void	setWriteBufferSize(int writeBufferSize)	Set the default size of Buffers, which will be allocated for writing data to Transport's Connections.
void	setWriteTimeout(long timeout, TimeUnit timeUnit)	Specifies the timeout for the blocking writes.
GrizzlyFuture<Transport>	shutdown()	Gracefully stops the transport accepting new connections and allows existing work to complete before finalizing the shutdown.
GrizzlyFuture<Transport>	shutdown(long gracePeriod, TimeUnit timeUnit)	Gracefully stops the transport accepting new connections and allows existing work to complete before finalizing the shutdown.
void	shutdownNow()	Forcibly stops the transport and closes all connections.
void	start()	Starts the transport
void	stop()	Deprecated. Use shutdownNow().

Field Details

DEFAULT_READ_BUFFER_SIZE

static final int DEFAULT_READ_BUFFER_SIZE

The default read buffer size.

See Also:

• Constant Field Values

DEFAULT_WRITE_BUFFER_SIZE

static final int DEFAULT_WRITE_BUFFER_SIZE

The default write buffer size.

See Also:

• Constant Field Values

DEFAULT_READ_TIMEOUT

static final int DEFAULT_READ_TIMEOUT

Default read timeout in seconds.

See Also:

• Constant Field Values

DEFAULT_WRITE_TIMEOUT

static final int DEFAULT_WRITE_TIMEOUT

Default write timeout in seconds.

See Also:

• Constant Field Values

Method Details

getName

String getName()

Gets the Transport name.

Returns:

the Transport name.

setName

void setName(String name)

Sets the Transport name.

Parameters:

name - the Transport name.

getState

StateHolder<Transport.State> getState()

Return the Transport state controller. Using the state controller, it is possible to get/set the Transport state in thread-safe manner.

Returns:

StateHolder state controller.

isBlocking

boolean isBlocking()

Returns the Transport mode. true, if Transport is operating in blocking mode, or false otherwise. Specific Transport Connections may override this setting by Connection.isBlocking().

Returns:

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

configureBlocking

void configureBlocking(boolean isBlocking)

Sets the Transport mode. Specific Transport Connections may override this setting by Connection.configureBlocking(boolean).

Parameters:

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

configureStandalone

void configureStandalone(boolean isStandalone)

isStandalone

boolean isStandalone()

obtainProcessor

Processor obtainProcessor(IOEvent ioEvent,
 Connection connection)

Gets the default Processor, which will process Transport Connections I/O events in case, if Connection doesn't have own Processor preferences. If Transport associated Processor is null, and Connection doesn't have any preferred Processor - then Transport will try to get Processor using ProcessorSelector.select(IOEvent, Connection).

Parameters:

ioEvent - the type of events the Processor should handle

connection - connection to obtain Processor for

Returns:

the default Processor, which will process Connection I/O events, if one doesn't have own Processor preferences.

getProcessor

Processor getProcessor()

Gets the default Processor, which will process Connection I/O events in case, if Connection doesn't have own Processor preferences. If Transport associated Processor is null, and Connection doesn't have any preferred Processor - then Transport will try to get Processor using ProcessorSelector.select(IOEvent, Connection).

Returns:

the default Processor, which will process Connection I/O events, if one doesn't have own Processor preferences.

setProcessor

void setProcessor(Processor processor)

Sets the default Processor, which will process Connection I/O events in case, if Connection doesn't have own Processor preferences.

Parameters:

processor - the default Processor, which will process Connection I/O events, if one doesn't have own Processor preferences.

getProcessorSelector

ProcessorSelector getProcessorSelector()

Gets the default ProcessorSelector, which will be used to get Processor to process Connection I/O events, in case if this Transport's Processor is null and Connection doesn't have neither preferred Processor nor ProcessorSelector. Transport's ProcessorSelector is the last place, where Transport will try to get Processor to process Connection I/O event. If ProcessorSelector is not set - IllegalStateException will be thrown.

Returns:

the default ProcessorSelector, which will be used to get Processor to process Connection I/O events, in case if this Transport's Processor is null and Connection doesn't have neither preferred Processor nor ProcessorSelector.

setProcessorSelector

void setProcessorSelector(ProcessorSelector selector)

Sets the default ProcessorSelector, which will be used to get Processor to process Connection I/O events, in case if this Transport's Processor is null and Connection doesn't have neither preferred Processor nor ProcessorSelector. Transport's ProcessorSelector is the last place, where Transport will try to get Processor to process Connection I/O event. If ProcessorSelector is not set - IllegalStateException will be thrown.

Parameters:

selector - the default ProcessorSelector, which will be used to get Processor to process Connection I/O events, in case if this Transport's Processor is null and Connection doesn't have neither preferred Processor nor ProcessorSelector.

getMemoryManager

MemoryManager getMemoryManager()

Get the Transport associated MemoryManager, which will be used by the Transport, its Connections and by during processing I/O events, occurred on Connections.

Returns:

the Transport associated MemoryManager, which will be used by the Transport, its Connections and by during processing I/O events, occurred on Connections.

setMemoryManager

void setMemoryManager(MemoryManager memoryManager)

Set the Transport associated MemoryManager, which will be used by the Transport, its Connections and by during processing I/O events, occurred on Connections.

Parameters:

memoryManager - the Transport associated MemoryManager, which will be used by the Transport, its Connections and by during processing I/O events, occurred on Connections.

getIOStrategy

IOStrategy getIOStrategy()

Get the IOStrategy implementation, which will be used by Transport to process IOEvent. IOStrategy is responsible for choosing the way, how I/O event will be processed: using current Thread, worker Thread; or make any other decisions.

Returns:

the IOStrategy implementation, which will be used by Transport to process IOEvent.

setIOStrategy

void setIOStrategy(IOStrategy IOStrategy)

Set the IOStrategy implementation, which will be used by Transport to process IOEvent. IOStrategy is responsible for choosing the way, how I/O event will be processed: using current Thread, worker Thread; or make any other decisions.

Parameters:

IOStrategy - the IOStrategy implementation, which will be used by Transport to process IOEvent.

getReadBufferSize

int getReadBufferSize()

Get the default size of Buffers, which will be allocated for reading data from Transport's Connections. For particular Connection, this setting could be overridden by Connection.getReadBufferSize().

Returns:

the default size of Buffers, which will be allocated for reading data from Transport's Connections.

setReadBufferSize

void setReadBufferSize(int readBufferSize)

Set the default size of Buffers, which will be allocated for reading data from Transport's Connections. For particular Connection, this setting could be overridden by Connection.setReadBufferSize(int). If not explicitly configured, this value will be set to DEFAULT_READ_BUFFER_SIZE.

Parameters:

readBufferSize - the default size of Buffers, which will be allocated for reading data from Transport's Connections.

getWriteBufferSize

int getWriteBufferSize()

Get the default size of Buffers, which will be allocated for writing data to Transport's Connections. For particular Connection, this setting could be overridden by Connection.getWriteBufferSize().

Returns:

the default size of Buffers, which will be allocated for writing data to Transport's Connections.

setWriteBufferSize

void setWriteBufferSize(int writeBufferSize)

Set the default size of Buffers, which will be allocated for writing data to Transport's Connections. For particular Connection, this setting could be overridden by Connection.setWriteBufferSize(int).

Parameters:

writeBufferSize - the default size of Buffers, which will be allocated for writing data to Transport's Connections.

getWorkerThreadPool

ExecutorService getWorkerThreadPool()

Get a thread pool, which will run IOEvent processing (depending on Transport IOStrategy) to let kernel threads continue their job.

Returns:

ExecutorService transport worker thread pool.

getKernelThreadPool

ExecutorService getKernelThreadPool()

Returns:

ExecutorService responsible for running Transport internal tasks. For example SelectorRunner threads for NIO.

setWorkerThreadPool

void setWorkerThreadPool(ExecutorService threadPool)

Set a thread pool, which will run IOEvent processing (depending on Transport IOStrategy) to let kernel threads continue their job.

Parameters:

threadPool - ExecutorService transport worker thread pool.

setKernelThreadPool

void setKernelThreadPool(ExecutorService threadPool)

Set a thread pool which will run Transport internal tasks. For example SelectorRunner threads for NIO.

Parameters:

threadPool - ExecutorService for SelectorRunners

setKernelThreadPoolConfig

void setKernelThreadPoolConfig(ThreadPoolConfig kernelConfig)

Set the ThreadPoolConfig to be used by the Transport internal thread pool.

Parameters:

kernelConfig - kernel thread pool configuration.

setWorkerThreadPoolConfig

void setWorkerThreadPoolConfig(ThreadPoolConfig workerConfig)

Set the ThreadPoolConfig to be used by the worker thread pool.

Parameters:

workerConfig - worker thread pool configuration.

getKernelThreadPoolConfig

ThreadPoolConfig getKernelThreadPoolConfig()

Returns:

the ThreadPoolConfig that will be used to construct the ExecutorService which will run the Transport's internal tasks. For example SelectorRunners for NIO.

getWorkerThreadPoolConfig

ThreadPoolConfig getWorkerThreadPoolConfig()

Returns:

the ThreadPoolConfig that will be used to construct the ExecutorService for IOStrategies that require worker threads. Depending on the IOStrategy being used, this may return null.

getAttributeBuilder

AttributeBuilder getAttributeBuilder()

Get Transport associated AttributeBuilder, which will be used by Transport and its Connections to store custom Attributes.

Returns:

Transport associated AttributeBuilder, which will be used by Transport and its Connections to store custom Attributes.

setAttributeBuilder

void setAttributeBuilder(AttributeBuilder attributeBuilder)

Set Transport associated AttributeBuilder, which will be used by Transport and its Connections to store custom Attributes.

Parameters:

attributeBuilder - Transport associated AttributeBuilder, which will be used by Transport and its Connections to store custom Attributes.

start

void start()
    throws IOException

Starts the transport

Throws:

IOException - if transport fails to start. This may not occur if Transport was not in Transport.State.STOPPED.

stop

@Deprecated
void stop()
   throws IOException

Deprecated.

Use shutdownNow().

Stops the transport and closes all the connections

Throws:

IOException - if there was an error shutting down

shutdown

GrizzlyFuture<Transport> shutdown()

Gracefully stops the transport accepting new connections and allows existing work to complete before finalizing the shutdown. This method will wait indefinitely for all interested parties to signal it is safe to terminate the transport. Invoke shutdownNow() to terminate the transport if the graceful shutdown is taking too long.

Returns:

a GrizzlyFuture which will return the stopped transport.

Since:

2.3.5

See Also:

• GracefulShutdownListener

shutdown

GrizzlyFuture<Transport> shutdown(long gracePeriod,
 TimeUnit timeUnit)

Gracefully stops the transport accepting new connections and allows existing work to complete before finalizing the shutdown. This method will wait for the specified time for all interested parties to signal it is safe to terminate the transport. If the timeout is exceeded, the transport will be terminated forcefully.

Parameters:

gracePeriod - the grace period for a graceful shutdown before the transport is forcibly terminated. If gracePeriod is zero or less, then there is no time limit for the shutdown.

timeUnit - the TimeUnit of the specified grace period.

Returns:

a GrizzlyFuture which will return the stopped transport.

Since:

2.3.5

shutdownNow

void shutdownNow()
          throws IOException

Forcibly stops the transport and closes all connections.

Throws:

IOException - if there was an error shutting down

Since:

2.3.5

See Also:

• to complete gracefully

addShutdownListener

boolean addShutdownListener(GracefulShutdownListener shutdownListener)

Adds a GracefulShutdownListener which will be called when shutdown() is called to enable graceful shutdown of transports. This allows the owner of the listener to signal that all shutdown tasks are complete and that it's safe to finalize the termination of the transport

Parameters:

shutdownListener - the GracefulShutdownListener

Returns:

true if the listener was successfully registered, otherwise false. When this method returns false it means one of two things: the transport is stopping or is stopped, or the listener has already been registered.

Since:

2.3.5

pause

void pause()

Pauses the transport

resume

void resume()

Resumes the transport after a pause

fireIOEvent

void fireIOEvent(IOEvent ioEvent,
 Connection connection,
 IOEventLifeCycleListener listener)

Fires specific IOEvent on the Connection

Parameters:

ioEvent - I/O event

connection - Connection, on which we fire the event.

listener - I/O event life-cycle listener.

isStopped

boolean isStopped()

Returns true, if this Transport is in stopped state, false otherwise.

Returns:

true, if this Transport is in stopped state, false otherwise.

isPaused

boolean isPaused()

getReader

Reader getReader(Connection connection)

Get the Reader to read data from the Connection. The Transport may decide to return blocking or non-blocking Reader depending on the Connection settings.

Parameters:

connection - Connection.

Returns:

Reader.

getReader

Reader getReader(boolean isBlocking)

Get the Reader implementation, depending on the requested mode.

Parameters:

isBlocking - blocking mode.

Returns:

Reader.

getWriter

Writer getWriter(Connection connection)

Get the Writer to write data to the Connection. The Transport may decide to return blocking or non-blocking Writer depending on the Connection settings.

Parameters:

connection - Connection.

Returns:

Writer.

getWriter

Writer getWriter(boolean isBlocking)

Get the Writer implementation, depending on the requested mode.

Parameters:

isBlocking - blocking mode.

Returns:

Writer.

getConnectionMonitoringConfig

MonitoringConfig<ConnectionProbe> getConnectionMonitoringConfig()

Get the monitoring configuration for Transport Connections.

Returns:

the configuration

getThreadPoolMonitoringConfig

MonitoringConfig<ThreadPoolProbe> getThreadPoolMonitoringConfig()

Get the monitoring configuration for Transport thread pool.

Returns:

the configuration

getMonitoringConfig

MonitoringConfig<TransportProbe> getMonitoringConfig()

Get the Transport monitoring configuration MonitoringConfig.

Specified by:

getMonitoringConfig in interface MonitoringAware<TransportProbe>

Returns:

the object associated MonitoringConfig.

notifyTransportError

void notifyTransportError(Throwable error)

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

Parameters:

error - Throwable.

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 value of the read timeout

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:

• Connection.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 value of the write timeout

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:

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