Package org.glassfish.grizzly

Class AbstractTransport

java.lang.Object

org.glassfish.grizzly.AbstractTransport

All Implemented Interfaces:

MonitoringAware<TransportProbe>, Transport

Direct Known Subclasses:

NIOTransport

public abstract class AbstractTransport
extends Object
implements Transport

Abstract Transport. Implements common transport functionality.

Author:

Alexey Stashok

Nested Class Summary

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

Transport.State

Field Summary

Fields

Modifier and Type	Field	Description
protected AttributeBuilder	attributeBuilder	Transport AttributeBuilder, which will be used to create Attributes
protected DefaultMonitoringConfig<ConnectionProbe>	connectionMonitoringConfig	Connection probes
protected boolean	isBlocking	Transport mode
protected boolean	isStandalone	Deprecated.
protected ExecutorService	kernelPool	Kernel thread pool.
protected ThreadPoolConfig	kernelPoolConfig
protected boolean	managedWorkerPool
protected MemoryManager	memoryManager	Transport MemoryManager
protected String	name	Transport name
protected Processor	processor	Transport default Processor
protected ProcessorSelector	processorSelector	Transport default ProcessorSelector
protected int	readBufferSize	Transport default buffer size for read operations
protected long	readTimeout
protected StateHolder<Transport.State>	state	Transport state controller
protected IOStrategy	strategy	Transport strategy
protected DefaultMonitoringConfig<ThreadPoolProbe>	threadPoolMonitoringConfig	Thread pool probes
protected DefaultMonitoringConfig<TransportProbe>	transportMonitoringConfig	Transport probes
protected ThreadPoolConfig	workerPoolConfig
protected ExecutorService	workerThreadPool	Worker thread pool
protected int	writeBufferSize	Transport default buffer size for write operations
protected long	writeTimeout

Fields inherited from interface org.glassfish.grizzly.Transport

DEFAULT_READ_BUFFER_SIZE, DEFAULT_READ_TIMEOUT, DEFAULT_WRITE_BUFFER_SIZE, DEFAULT_WRITE_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
AbstractTransport(String name)

Method Summary

Modifier and Type	Method	Description
protected abstract void	closeConnection(Connection connection)	Close the connection, managed by Transport
void	configureBlocking(boolean isBlocking)	Sets the Transport mode.
protected abstract Object	createJmxManagementObject()	Create the Transport JMX management object.
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.
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.
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.
protected static void	notifyProbesBeforePause(AbstractTransport transport)	Notify registered TransportProbes about the before-pause event.
protected static void	notifyProbesBeforeResume(AbstractTransport transport)	Notify registered TransportProbes about the before-resume event.
protected static void	notifyProbesBeforeStart(AbstractTransport transport)	Notify registered TransportProbes about the before-start event.
protected static void	notifyProbesBeforeStop(AbstractTransport transport)	Notify registered TransportProbes about the before-stop event.
protected static void	notifyProbesConfigChanged(AbstractTransport transport)	Notify registered TransportProbes about the config changed event.
protected static void	notifyProbesPause(AbstractTransport transport)	Notify registered TransportProbes about the pause event.
protected static void	notifyProbesStop(AbstractTransport transport)	Notify registered TransportProbes about the stop event.
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	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.
protected void	setKernelPool0(ExecutorService kernelPool)
void	setKernelThreadPool(ExecutorService kernelPool)	Set a thread pool which will run Transport internal tasks.
void	setKernelThreadPoolConfig(ThreadPoolConfig kernelPoolConfig)	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.
protected void	setWorkerThreadPool0(ExecutorService threadPool)
void	setWorkerThreadPoolConfig(ThreadPoolConfig workerPoolConfig)	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.
void	stop()	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.Transport

addShutdownListener, configureStandalone, fireIOEvent, getReader, getReader, getWriter, getWriter, notifyTransportError, pause, resume, shutdown, shutdown, shutdownNow, start

Field Detail

name

protected String name

Transport name

isBlocking

protected volatile boolean isBlocking

Transport mode

isStandalone

@Deprecated
protected volatile boolean isStandalone

Deprecated.

state

protected final StateHolder<Transport.State> state

Transport state controller

processor

protected Processor processor

Transport default Processor

processorSelector

protected ProcessorSelector processorSelector

Transport default ProcessorSelector

strategy

protected IOStrategy strategy

Transport strategy

memoryManager

protected MemoryManager memoryManager

Transport MemoryManager

workerThreadPool

protected ExecutorService workerThreadPool

Worker thread pool

kernelPool

protected ExecutorService kernelPool

Kernel thread pool.

attributeBuilder

protected AttributeBuilder attributeBuilder

Transport AttributeBuilder, which will be used to create Attributes

readBufferSize

protected int readBufferSize

Transport default buffer size for read operations

writeBufferSize

protected int writeBufferSize

Transport default buffer size for write operations

workerPoolConfig

protected ThreadPoolConfig workerPoolConfig

kernelPoolConfig

protected ThreadPoolConfig kernelPoolConfig

managedWorkerPool

protected boolean managedWorkerPool

writeTimeout

protected long writeTimeout

readTimeout

protected long readTimeout

transportMonitoringConfig

protected final DefaultMonitoringConfig<TransportProbe> transportMonitoringConfig

Transport probes

connectionMonitoringConfig

protected final DefaultMonitoringConfig<ConnectionProbe> connectionMonitoringConfig

Connection probes

threadPoolMonitoringConfig

protected final DefaultMonitoringConfig<ThreadPoolProbe> threadPoolMonitoringConfig

Thread pool probes

Constructor Detail

AbstractTransport

public AbstractTransport(String name)

Method Detail

getName

public String getName()

Gets the Transport name.

Specified by:

getName in interface Transport

Returns:

the Transport name.

setName

public void setName(String name)

Sets the Transport name.

Specified by:

setName in interface Transport

Parameters:

name - the Transport name.

isBlocking

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

Specified by:

isBlocking in interface Transport

Returns:

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

configureBlocking

public void configureBlocking(boolean isBlocking)

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

Specified by:

configureBlocking in interface Transport

Parameters:

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

isStandalone

public boolean isStandalone()

Specified by:

isStandalone in interface Transport

getState

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

Specified by:

getState in interface Transport

Returns:

StateHolder state controller.

getReadBufferSize

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

Specified by:

getReadBufferSize in interface Transport

Returns:

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

setReadBufferSize

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

Specified by:

setReadBufferSize in interface Transport

Parameters:

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

getWriteBufferSize

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

Specified by:

getWriteBufferSize in interface Transport

Returns:

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

setWriteBufferSize

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

Specified by:

setWriteBufferSize in interface Transport

Parameters:

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

isStopped

public boolean isStopped()

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

Specified by:

isStopped in interface Transport

Returns:

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

isPaused

public boolean isPaused()

Specified by:

isPaused in interface Transport

obtainProcessor

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

Specified by:

obtainProcessor in interface Transport

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

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

Specified by:

getProcessor in interface Transport

Returns:

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

setProcessor

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

Specified by:

setProcessor in interface Transport

Parameters:

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

getProcessorSelector

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

Specified by:

getProcessorSelector in interface Transport

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

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

Specified by:

setProcessorSelector in interface Transport

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.

getIOStrategy

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

Specified by:

getIOStrategy in interface Transport

Returns:

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

setIOStrategy

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

Specified by:

setIOStrategy in interface Transport

Parameters:

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

getMemoryManager

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

Specified by:

getMemoryManager in interface Transport

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

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

Specified by:

setMemoryManager in interface Transport

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.

getWorkerThreadPool

public ExecutorService getWorkerThreadPool()

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

Specified by:

getWorkerThreadPool in interface Transport

Returns:

ExecutorService transport worker thread pool.

getKernelThreadPool

public ExecutorService getKernelThreadPool()

Specified by:

getKernelThreadPool in interface Transport

Returns:

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

setKernelThreadPool

public void setKernelThreadPool(ExecutorService kernelPool)

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

Specified by:

setKernelThreadPool in interface Transport

Parameters:

kernelPool - ExecutorService for SelectorRunners

setKernelThreadPoolConfig

public void setKernelThreadPoolConfig(ThreadPoolConfig kernelPoolConfig)

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

Specified by:

setKernelThreadPoolConfig in interface Transport

Parameters:

kernelPoolConfig - kernel thread pool configuration.

setWorkerThreadPoolConfig

public void setWorkerThreadPoolConfig(ThreadPoolConfig workerPoolConfig)

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

Specified by:

setWorkerThreadPoolConfig in interface Transport

Parameters:

workerPoolConfig - worker thread pool configuration.

getKernelThreadPoolConfig

public ThreadPoolConfig getKernelThreadPoolConfig()

Specified by:

getKernelThreadPoolConfig in interface Transport

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

public ThreadPoolConfig getWorkerThreadPoolConfig()

Specified by:

getWorkerThreadPoolConfig in interface Transport

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.

setWorkerThreadPool

public void setWorkerThreadPool(ExecutorService threadPool)

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

Specified by:

setWorkerThreadPool in interface Transport

Parameters:

threadPool - ExecutorService transport worker thread pool.

setWorkerThreadPool0

protected void setWorkerThreadPool0(ExecutorService threadPool)

setKernelPool0

protected void setKernelPool0(ExecutorService kernelPool)

getAttributeBuilder

public AttributeBuilder getAttributeBuilder()

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

Specified by:

getAttributeBuilder in interface Transport

Returns:

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

setAttributeBuilder

public void setAttributeBuilder(AttributeBuilder attributeBuilder)

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

Specified by:

setAttributeBuilder in interface Transport

Parameters:

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

closeConnection

protected abstract void closeConnection(Connection connection)
                                 throws IOException

Close the connection, managed by Transport

Parameters:

connection - NIOConnection to close

Throws:

IOException - not used

getConnectionMonitoringConfig

public MonitoringConfig<ConnectionProbe> getConnectionMonitoringConfig()

Get the monitoring configuration for Transport Connections.

Specified by:

getConnectionMonitoringConfig in interface Transport

Returns:

the configuration

getMonitoringConfig

public MonitoringConfig<TransportProbe> getMonitoringConfig()

Get the Transport monitoring configuration MonitoringConfig.

Specified by:

getMonitoringConfig in interface MonitoringAware<TransportProbe>

Specified by:

getMonitoringConfig in interface Transport

Returns:

the object associated MonitoringConfig.

getThreadPoolMonitoringConfig

public MonitoringConfig<ThreadPoolProbe> getThreadPoolMonitoringConfig()

Get the monitoring configuration for Transport thread pool.

Specified by:

getThreadPoolMonitoringConfig in interface Transport

Returns:

the configuration

getReadTimeout

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.

Specified by:

getReadTimeout in interface Transport

Parameters:

timeUnit - the TimeUnit to convert the returned result to.

Returns:

the value of the read timeout

setReadTimeout

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.

Specified by:

setReadTimeout in interface Transport

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)

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 Transport

Parameters:

timeUnit - the TimeUnit to convert the returned result to.

Returns:

the value of the write timeout

setWriteTimeout

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.

Specified by:

setWriteTimeout in interface Transport

Parameters:

timeout - the new timeout value

timeUnit - the TimeUnit specification of the provided value.

See Also:

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

notifyProbesBeforeStart

protected static void notifyProbesBeforeStart(AbstractTransport transport)

Notify registered TransportProbes about the before-start event.

Parameters:

transport - the Transport event occurred on.

Since:

3.0

notifyProbesBeforeStop

protected static void notifyProbesBeforeStop(AbstractTransport transport)

Notify registered TransportProbes about the before-stop event.

Parameters:

transport - the Transport event occurred on.

Since:

3.0

notifyProbesStop

protected static void notifyProbesStop(AbstractTransport transport)

Notify registered TransportProbes about the stop event.

Parameters:

transport - the Transport event occurred on.

notifyProbesBeforePause

protected static void notifyProbesBeforePause(AbstractTransport transport)

Notify registered TransportProbes about the before-pause event.

Parameters:

transport - the Transport event occurred on.

Since:

3.0

notifyProbesPause

protected static void notifyProbesPause(AbstractTransport transport)

Notify registered TransportProbes about the pause event.

Parameters:

transport - the Transport event occurred on.

notifyProbesBeforeResume

protected static void notifyProbesBeforeResume(AbstractTransport transport)

Notify registered TransportProbes about the before-resume event.

Parameters:

transport - the Transport event occurred on.

Since:

3.0

notifyProbesConfigChanged

protected static void notifyProbesConfigChanged(AbstractTransport transport)

Notify registered TransportProbes about the config changed event.

Parameters:

transport - the Transport event occurred on.

stop

@Deprecated
public void stop()
          throws IOException

Deprecated.

Stops the transport and closes all the connections

Specified by:

stop in interface Transport

Throws:

IOException - if there was an error shutting down

createJmxManagementObject

protected abstract Object createJmxManagementObject()

Create the Transport JMX management object.

Returns:

the Transport JMX management object.