reactor.core

Class Environment

java.lang.Object

reactor.core.Environment

All Implemented Interfaces:

java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<Dispatcher>>>

public class Environment
extends java.lang.Object
implements java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<Dispatcher>>>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_LOOP The name of the default event loop dispatcher
static int	PROCESSORS The number of processors available to the runtime
static java.lang.String	RING_BUFFER The name of the default ring buffer dispatcher
static java.lang.String	THREAD_POOL The name of the default thread pool dispatcher
static java.lang.String	WORK_QUEUE The name of the default work queue dispatcher

Constructor Summary

Constructors

Constructor and Description
Environment() Creates a new Environment that will use a PropertiesConfigurationReader to obtain its initial configuration.
Environment(ConfigurationReader configurationReader) Creates a new Environment that will use the given configurationReader to obtain its initial configuration.
Environment(java.util.Map<java.lang.String,java.util.List<Dispatcher>> dispatchers, ConfigurationReader configurationReader) Creates a new Environment that will contain the given dispatchers, will use the given configurationReader to obtain additional configuration.

Method Summary

Modifier and Type	Method and Description
Environment	addDispatcher(java.lang.String name, Dispatcher dispatcher) Adds the dispatcher to the environment, storing it using the given name.
Dispatcher	getDefaultDispatcher() Returns the default dispatcher for this environment.
Dispatcher	getDispatcher(java.lang.String name) Returns the dispatcher with the given name.
<T> T	getProperty(java.lang.String key, java.lang.Class<T> type, T defaultValue) Gets the property with the given key, converting it to the required type using the standard converters.
java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue) Gets the property with the given key.
Reactor	getRootReactor() Returns this environments root Reactor, creating it if necessary.
Timer	getRootTimer() Get the Environment-wide SimpleHashWheelTimer.
java.util.Iterator<java.util.Map.Entry<java.lang.String,java.util.List<Dispatcher>>>	iterator()
Environment	removeDispatcher(java.lang.String name) Removes the Dispatcher, stored using the given name from the environment.
void	shutdown() Shuts down this Environment, causing all of its Dispatchers to be shut down.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EVENT_LOOP

public static final java.lang.String EVENT_LOOP

The name of the default event loop dispatcher

See Also:

Constant Field Values

RING_BUFFER

public static final java.lang.String RING_BUFFER

The name of the default ring buffer dispatcher

See Also:

Constant Field Values

THREAD_POOL

public static final java.lang.String THREAD_POOL

The name of the default thread pool dispatcher

See Also:

Constant Field Values

WORK_QUEUE

public static final java.lang.String WORK_QUEUE

The name of the default work queue dispatcher

See Also:

Constant Field Values

PROCESSORS

public static final int PROCESSORS

The number of processors available to the runtime

See Also:

Runtime.availableProcessors()

Constructor Detail

Environment

public Environment()

Creates a new Environment that will use a PropertiesConfigurationReader to obtain its initial configuration. The configuration will be read from the classpath at the location META-INF/reactor/default.properties.

Environment

public Environment(ConfigurationReader configurationReader)

Creates a new Environment that will use the given configurationReader to obtain its initial configuration.

Parameters:

configurationReader - The configuration reader to use to obtain initial configuration

Environment

public Environment(java.util.Map<java.lang.String,java.util.List<Dispatcher>> dispatchers,
                   ConfigurationReader configurationReader)

Creates a new Environment that will contain the given dispatchers, will use the given configurationReader to obtain additional configuration.

Parameters:

dispatchers - The dispatchers to add include in the Environment

configurationReader - The configuration reader to use to obtain additional configuration

Method Detail

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String defaultValue)

Gets the property with the given key. If the property does not exist defaultValue will be returned.

Parameters:

key - The property key

defaultValue - The value to return if the property does not exist

Returns:

The value for the property

getProperty

public <T> T getProperty(java.lang.String key,
                         java.lang.Class<T> type,
                         T defaultValue)

Gets the property with the given key, converting it to the required type using the standard converters. fF the property does not exist defaultValue will be returned.

Parameters:

key - The property key

type - The type to convert the property to

defaultValue - The value to return if the property does not exist

Returns:

The converted value for the property

getDefaultDispatcher

public Dispatcher getDefaultDispatcher()

Returns the default dispatcher for this environment. By default, when a PropertiesConfigurationReader is being used. This default dispatcher is specified by the value of the reactor.dispatchers.default property.

Returns:

The default dispatcher

getDispatcher

public Dispatcher getDispatcher(java.lang.String name)

Returns the dispatcher with the given name.

Parameters:

name - The name of the dispatcher

Returns:

The matching dispatcher, never null.

Throws:

java.lang.IllegalArgumentException - if the dispatcher does not exist

addDispatcher

public Environment addDispatcher(java.lang.String name,
                                 Dispatcher dispatcher)

Adds the dispatcher to the environment, storing it using the given name.

Parameters:

name - The name of the dispatcher

dispatcher - The dispatcher

Returns:

This Environment

removeDispatcher

public Environment removeDispatcher(java.lang.String name)

Removes the Dispatcher, stored using the given name from the environment.

Parameters:

name - The name of the dispatcher

Returns:

This Environment

getRootReactor

public Reactor getRootReactor()

Returns this environments root Reactor, creating it if necessary. The Reactor will use the environment default dispatcher.

Returns:

The root reactor

See Also:

getDefaultDispatcher()

getRootTimer

public Timer getRootTimer()

Get the Environment-wide SimpleHashWheelTimer.

Returns:

the timer.

shutdown

public void shutdown()

Shuts down this Environment, causing all of its Dispatchers to be shut down.

See Also:

Dispatcher.shutdown()

iterator

public java.util.Iterator<java.util.Map.Entry<java.lang.String,java.util.List<Dispatcher>>> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<Dispatcher>>>