Fill this out to configure a Driver. More...

Inherits Org.Apache.REEF.Tang.Formats.ConfigurationModuleBuilder.

Static Public Attributes
static readonly RequiredImpl< IObserver< IDriverStarted > >	OnDriverStarted
	The event handler called after the Driver started. More...

static readonly OptionalImpl< IObserver< IDriverRestarted > >	OnDriverRestarted
	The event handler invoked when driver restarts More...

static readonly OptionalImpl< IObserver< IAllocatedEvaluator > >	OnEvaluatorAllocated
	Event handler for allocated evaluators. More...

static readonly OptionalImpl< IObserver< ICompletedEvaluator > >	OnEvaluatorCompleted
	Event handler for completed evaluators. More...

static readonly OptionalImpl< IObserver< IFailedEvaluator > >	OnEvaluatorFailed
	Event handler for failed evaluators. More...

static readonly OptionalImpl< IHttpHandler >	OnHttpEvent = new OptionalImpl<IHttpHandler>()
	Event handler for for HTTP calls to the Driver's HTTP server. More...

static readonly OptionalImpl< IObserver< ITaskMessage > >	OnTaskMessage
	Event handler for task messages. More...

static readonly OptionalImpl< IObserver< ICompletedTask > >	OnTaskCompleted
	Event handler for completed tasks. More...

static readonly OptionalImpl< IObserver< IFailedTask > >	OnTaskFailed
	Event handler for failed tasks. More...

static readonly OptionalImpl< IObserver< IRunningTask > >	OnTaskRunning

static readonly OptionalImpl< IObserver< IRunningTask > >	OnDriverRestartTaskRunning

static readonly OptionalImpl< IObserver< ISuspendedTask > >	OnTaskSuspended
	Event handler for suspended tasks. More...

static readonly OptionalImpl< IObserver< IActiveContext > >	OnContextActive
	Event handler for active context. More...

static readonly OptionalImpl< IObserver< IActiveContext > >	OnDriverRestartContextActive
	Event handler for active context received during driver restart. More...

static readonly OptionalImpl< IObserver< IClosedContext > >	OnContextClosed
	Event handler for closed context. More...

static readonly OptionalImpl< IObserver< IFailedContext > >	OnContextFailed
	Event handler for closed context. More...

static readonly OptionalImpl< IObserver< IContextMessage > >	OnContextMessage
	Event handler for context messages. More...

static readonly OptionalImpl< IObserver< IDriverRestartCompleted > >	OnDriverRestartCompleted
	Event handler for driver restart completed. More...

static readonly OptionalImpl< IObserver< IFailedEvaluator > >	OnDriverRestartEvaluatorFailed

static readonly OptionalParameter< string >	CommandLineArguments = new OptionalParameter<string>()
	Additional set of string arguments that can be passed to handlers through client More...

static readonly OptionalParameter< string >	CustomTraceLevel = new OptionalParameter<string>()
	The trace level of the TraceListener More...

static readonly OptionalParameter< TraceListener >	CustomTraceListeners
	Additional set of trace listeners provided by client More...

static readonly OptionalImpl< IDriverConnection >	OnDriverReconnect = new OptionalImpl<IDriverConnection>()
	The implemenation for (attempting to) re-establish connection to driver TODO[JIRA REEF-1306]: Remove. More...

static readonly OptionalImpl< IDriverReconnConfigProvider >	DriverReconnectionConfigurationProvider
	The configuration provider for driver reconnection. More...

static readonly OptionalParameter< int >	DriverRestartEvaluatorRecoverySeconds = new OptionalParameter<int>()
	Evaluator recovery timeout for driver restart in seconds. More...

static readonly OptionalImpl< IProgressProvider >	ProgressProvider = new OptionalImpl<IProgressProvider>()
	The progress provider that will be injected at the Driver. More...

Properties
static ConfigurationModule	ConfigurationModule `[get]`

Additional Inherited Members
Public Member Functions inherited from Org.Apache.REEF.Tang.Formats.ConfigurationModuleBuilder
	ConfigurationModuleBuilder ()

ConfigurationModuleBuilder	Merge (ConfigurationModule d)

ConfigurationModuleBuilder	BindSetEntry< U, T > (GenericType< U > iface, string impl)

ConfigurationModuleBuilder	BindSetEntry< U, V, T > (GenericType< U > iface, GenericType< V > impl)

ConfigurationModuleBuilder	BindSetEntry< U, T > (GenericType< U > iface, IImpl< T > opt)

ConfigurationModuleBuilder	BindSetEntry< U, T > (GenericType< U > iface, IParam< T > opt)

ConfigurationModuleBuilder	BindList< U, T > (GenericType< U > iface, IList< string > impl)

ConfigurationModuleBuilder	BindList< U, T > (GenericType< U > iface, IImpl< IList< T >> opt)

ConfigurationModuleBuilder	BindList< U, T > (GenericType< U > iface, IParam< IList< T >> opt)

ConfigurationModuleBuilder	BindImplementation< U, T > (GenericType< U > iface, GenericType< T > impl)

ConfigurationModuleBuilder	BindImplementation< T > (GenericType< T > iface, string impl)

ConfigurationModuleBuilder	BindImplementation< U, T > (GenericType< T > iface, IImpl< U > opt)

ConfigurationModuleBuilder	BindNamedParameter< U, T > (GenericType< U > name, string value)

ConfigurationModuleBuilder	BindNamedParameter< U, T > (GenericType< U > name, IParam< T > opt)

ConfigurationModuleBuilder	BindNamedParameter< U, V, T > (GenericType< U > iface, GenericType< V > impl)

ConfigurationModuleBuilder	BindNamedParameter< U, T > (GenericType< U > iface, GenericType< T > impl)

ConfigurationModuleBuilder	BindNamedParameter< U, V, T > (GenericType< U > iface, IImpl< V > opt)

ConfigurationModuleBuilder	BindNamedParameter< U, T > (GenericType< U > iface, IImpl< T > opt)

ConfigurationModuleBuilder	BindConstructor< T, U > (GenericType< T > clazz, GenericType< U > constructor)

ConfigurationModuleBuilder	BindConstructor< T, U > (GenericType< T > cons, IImpl< U > v)

ConfigurationModule	Build ()

ConfigurationModuleBuilder	DeepCopy ()

string	ToString (ISet< FieldInfo > s)

Public Attributes inherited from Org.Apache.REEF.Tang.Formats.ConfigurationModuleBuilder
readonly ICsConfigurationBuilder	B = TangFactory.GetTang().NewConfigurationBuilder()

readonly MonotonicHashSet< FieldInfo >	ReqDecl = new MonotonicHashSet<FieldInfo>()

readonly MonotonicHashSet< FieldInfo >	OptDecl = new MonotonicHashSet<FieldInfo>()

readonly MonotonicHashSet< object >	SetOpts = new MonotonicHashSet<object>()

readonly MonotonicHashMap< object, FieldInfo >	Map = new MonotonicHashMap<object, FieldInfo>()

readonly MonotonicHashMap< Type, object >	FreeImpls = new MonotonicHashMap<Type, object>()

readonly MonotonicHashMap< Type, object >	FreeParams = new MonotonicHashMap<Type, object>()

Detailed Description

Fill this out to configure a Driver.

Member Data Documentation

readonly OptionalParameter<string> Org.Apache.REEF.Driver.DriverConfiguration.CommandLineArguments = new OptionalParameter<string>()

static

Additional set of string arguments that can be passed to handlers through client

readonly OptionalParameter<string> Org.Apache.REEF.Driver.DriverConfiguration.CustomTraceLevel = new OptionalParameter<string>()

static

The trace level of the TraceListener

readonly OptionalParameter<TraceListener> Org.Apache.REEF.Driver.DriverConfiguration.CustomTraceListeners

static

Initial value:

=

new OptionalParameter<TraceListener>()

Additional set of trace listeners provided by client

readonly OptionalImpl<IDriverReconnConfigProvider> Org.Apache.REEF.Driver.DriverConfiguration.DriverReconnectionConfigurationProvider

static

Initial value:

=

new OptionalImpl<IDriverReconnConfigProvider>()

The configuration provider for driver reconnection.

readonly OptionalParameter<int> Org.Apache.REEF.Driver.DriverConfiguration.DriverRestartEvaluatorRecoverySeconds = new OptionalParameter<int>()

static

Evaluator recovery timeout for driver restart in seconds.

If value is greater than 0, restart is enabled. The default value is -1.

readonly OptionalImpl<IObserver<IActiveContext> > Org.Apache.REEF.Driver.DriverConfiguration.OnContextActive

static

Initial value:

=

new OptionalImpl<IObserver<IActiveContext>>()

Event handler for active context.

Defaults to closing the context if not bound.

readonly OptionalImpl<IObserver<IClosedContext> > Org.Apache.REEF.Driver.DriverConfiguration.OnContextClosed

static

Initial value:

=

new OptionalImpl<IObserver<IClosedContext>>()

Event handler for closed context.

Defaults to logging if not bound.

readonly OptionalImpl<IObserver<IFailedContext> > Org.Apache.REEF.Driver.DriverConfiguration.OnContextFailed

static

Initial value:

=

new OptionalImpl<IObserver<IFailedContext>>()

Event handler for closed context.

Defaults to job failure if not bound.

readonly OptionalImpl<IObserver<IContextMessage> > Org.Apache.REEF.Driver.DriverConfiguration.OnContextMessage

static

Initial value:

=

new OptionalImpl<IObserver<IContextMessage>>()

Event handler for context messages.

Defaults to logging if not bound.

readonly OptionalImpl<IDriverConnection> Org.Apache.REEF.Driver.DriverConfiguration.OnDriverReconnect = new OptionalImpl<IDriverConnection>()

static

The implemenation for (attempting to) re-establish connection to driver TODO[JIRA REEF-1306]: Remove.

readonly OptionalImpl<IObserver<IDriverRestartCompleted> > Org.Apache.REEF.Driver.DriverConfiguration.OnDriverRestartCompleted

static

Initial value:

=

new OptionalImpl<IObserver<IDriverRestartCompleted>>()

Event handler for driver restart completed.

Defaults to logging if not bound.

readonly OptionalImpl<IObserver<IActiveContext> > Org.Apache.REEF.Driver.DriverConfiguration.OnDriverRestartContextActive

static

Initial value:

=

new OptionalImpl<IObserver<IActiveContext>>()

Event handler for active context received during driver restart.

Defaults to closing the context if not bound.

readonly OptionalImpl<IObserver<IDriverRestarted> > Org.Apache.REEF.Driver.DriverConfiguration.OnDriverRestarted

static

Initial value:

=

new OptionalImpl<IObserver<IDriverRestarted>>()

The event handler invoked when driver restarts

readonly OptionalImpl<IObserver<IFailedEvaluator> > Org.Apache.REEF.Driver.DriverConfiguration.OnDriverRestartEvaluatorFailed

static

Initial value:

=

new OptionalImpl<IObserver<IFailedEvaluator>>()

readonly OptionalImpl<IObserver<IRunningTask> > Org.Apache.REEF.Driver.DriverConfiguration.OnDriverRestartTaskRunning

static

Initial value:

=

new OptionalImpl<IObserver<IRunningTask>>()

readonly RequiredImpl<IObserver<IDriverStarted> > Org.Apache.REEF.Driver.DriverConfiguration.OnDriverStarted

static

Initial value:

=

new RequiredImpl<IObserver<IDriverStarted>>()

The event handler called after the Driver started.

readonly OptionalImpl<IObserver<IAllocatedEvaluator> > Org.Apache.REEF.Driver.DriverConfiguration.OnEvaluatorAllocated

static

Initial value:

=

new OptionalImpl<IObserver<IAllocatedEvaluator>>()

Event handler for allocated evaluators.

Defaults to returning the evaluator if not bound.

readonly OptionalImpl<IObserver<ICompletedEvaluator> > Org.Apache.REEF.Driver.DriverConfiguration.OnEvaluatorCompleted

static

Initial value:

=

new OptionalImpl<IObserver<ICompletedEvaluator>>()

Event handler for completed evaluators.

Defaults to logging if not bound.

readonly OptionalImpl<IObserver<IFailedEvaluator> > Org.Apache.REEF.Driver.DriverConfiguration.OnEvaluatorFailed

static

Initial value:

=

new OptionalImpl<IObserver<IFailedEvaluator>>()

Event handler for failed evaluators.

Defaults to job failure if not bound.

readonly OptionalImpl<IHttpHandler> Org.Apache.REEF.Driver.DriverConfiguration.OnHttpEvent = new OptionalImpl<IHttpHandler>()

static

Event handler for for HTTP calls to the Driver's HTTP server.

readonly OptionalImpl<IObserver<ICompletedTask> > Org.Apache.REEF.Driver.DriverConfiguration.OnTaskCompleted

static

Initial value:

=

new OptionalImpl<IObserver<ICompletedTask>>()

Event handler for completed tasks.

Defaults to closing the context the task ran on if not bound.

readonly OptionalImpl<IObserver<IFailedTask> > Org.Apache.REEF.Driver.DriverConfiguration.OnTaskFailed

static

Initial value:

=

new OptionalImpl<IObserver<IFailedTask>>()

Event handler for failed tasks.

Defaults to job failure if not bound.

readonly OptionalImpl<IObserver<ITaskMessage> > Org.Apache.REEF.Driver.DriverConfiguration.OnTaskMessage

static

Initial value:

=

new OptionalImpl<IObserver<ITaskMessage>>()

Event handler for task messages.

Defaults to logging if not bound.

readonly OptionalImpl<IObserver<IRunningTask> > Org.Apache.REEF.Driver.DriverConfiguration.OnTaskRunning

static

Initial value:

=

new OptionalImpl<IObserver<IRunningTask>>()

readonly OptionalImpl<IObserver<ISuspendedTask> > Org.Apache.REEF.Driver.DriverConfiguration.OnTaskSuspended

static

Initial value:

=

new OptionalImpl<IObserver<ISuspendedTask>>()

Event handler for suspended tasks.

Defaults to job failure if not bound.

Rationale: many jobs don't support task suspension. Hence, this parameter should be optional. The only sane default is to crash the job, then.

readonly OptionalImpl<IProgressProvider> Org.Apache.REEF.Driver.DriverConfiguration.ProgressProvider = new OptionalImpl<IProgressProvider>()

static

The progress provider that will be injected at the Driver.

Property Documentation

ConfigurationModule Org.Apache.REEF.Driver.DriverConfiguration.ConfigurationModule

staticget

The documentation for this class was generated from the following file:

lang/cs/Org.Apache.REEF.Driver/DriverConfiguration.cs

Static Public Attributes

Properties

Additional Inherited Members

Detailed Description

Member Data Documentation

Property Documentation