Uses of Class
org.apache.reef.annotations.audience.Public

Packages that use Public

Package	Description
org.apache.reef.client	Client APIs for REEF.
org.apache.reef.driver	Driver APIs for REEF in terms of Rx.
org.apache.reef.driver.client	Representations of the Client (i.e.
org.apache.reef.driver.context	Driver Contexts and their configurations.
org.apache.reef.driver.evaluator	Evaluator-related utilities.
org.apache.reef.driver.restart	This package provides restart event service handlers.
org.apache.reef.driver.task	Tasks and their configurations.
org.apache.reef.evaluator.context	Evaluator Contexts.
org.apache.reef.evaluator.context.events	Events signaling change of Evaluator state.
org.apache.reef.io	APIs for I/O in REEF: Codecs and Serializers.
org.apache.reef.io.checkpoint.fs	FileSystem based checkpoints.
org.apache.reef.io.naming	Utilities for assigning Identifiers to objects and associating socket addresses with them.
org.apache.reef.runtime.mesos.client	Client-side event handlers for Mesos resourcemanager.
org.apache.reef.runtime.yarn.client	Client-side event handlers for YARN resourcemanager.
org.apache.reef.runtime.yarn.driver	The Driver-Side implementation of the YARN adapter for REEF.
org.apache.reef.task	Tasks.
org.apache.reef.task.events	Task-related events.
org.apache.reef.tests	Tests for REEF implementations.
org.apache.reef.vortex.api	Vortex user api for running jobs on Vortex.

Uses of Public in org.apache.reef.client

Classes in org.apache.reef.client with annotations of type Public

Modifier and Type	Interface and Description
interface	CompletedJob Represents a completed REEF job.
class	DriverConfiguration A ConfigurationModule for Drivers.
class	DriverLauncher A launcher for REEF Drivers.
class	DriverRestartConfiguration EventHandlers specific to Driver Restart.
class	DriverServiceConfiguration Use this ConfigurationModule to configure Services to be run in the Driver.
class	FailedJob An error message that REEF Client receives when there is a user error in REEF job.
class	JobMessage A message received by the client from the driver.
interface	REEF The main entry point into the REEF resourcemanager.
interface	RunningJob Represents a running REEF job.

Uses of Public in org.apache.reef.driver

Classes in org.apache.reef.driver with annotations of type Public

Modifier and Type	Interface and Description
interface	ContextAndTaskSubmittable Base interface for classes that support the simultaneous submission of both Context and Task configurations.
interface	ContextSubmittable Base interface for classes that support Context submission.
class	DefaultProgressProvider The default implementation of ProgressProvider.
interface	PreemptionEvent Represents Preemption requests issued by the underlying resource manager.
interface	PreemptionHandler This EventHandler will receive preemption events from the underlying resourcemanager.
interface	ProgressProvider Used in the to report the progress of the REEF application.
interface	StrictPreemptionEvent Represents a strict preemption event: It contains the set of Evaluators that the underlying resource manager will take away from the Driver.
interface	TaskSubmittable Base interface for classes that support Task submission.

Uses of Public in org.apache.reef.driver.client

Classes in org.apache.reef.driver.client with annotations of type Public

Modifier and Type	Interface and Description
interface	JobMessageObserver The driver uses this interface to communicate with the job client.

Uses of Public in org.apache.reef.driver.context

Classes in org.apache.reef.driver.context with annotations of type Public

Modifier and Type	Interface and Description
interface	ActiveContext Represents an active context on an Evaluator.
interface	ClosedContext Represents a Context that has been closed successfully.
interface	ContextBase A common base interface for all Driver-side representations of Contexts.
class	ContextConfiguration A ConfigurationModule for Context Configuration.
interface	ContextMessage Driver-side representation of a message sent by a Context to the Driver.
interface	FailedContext Represents Context that failed.

Uses of Public in org.apache.reef.driver.evaluator

Classes in org.apache.reef.driver.evaluator with annotations of type Public

Modifier and Type	Interface and Description
interface	AllocatedEvaluator Represents an Evaluator that is allocated, but is not running yet.
interface	CompletedEvaluator Represents a successfully closed Evaluator.
interface	EvaluatorProcessFactory<T> Factory to create new evaluator process setups.
class	EvaluatorRequest A request for one ore more Evaluators.
interface	EvaluatorRequestor Interface through which Evaluators can be requested.
interface	FailedEvaluator Represents an Evaluator that became unavailable.

Uses of Public in org.apache.reef.driver.restart

Classes in org.apache.reef.driver.restart with annotations of type Public

Modifier and Type	Interface and Description
interface	DriverRestartCompleted The object used to notify the user that the Driver Restart process has been completed.
interface	DriverRestarted Am event encapsulating the time of Driver restart as well as the set of Evaluator IDs of Evaluators that are expected to report back to the Driver after restart.

Uses of Public in org.apache.reef.driver.task

Classes in org.apache.reef.driver.task with annotations of type Public

Modifier and Type	Interface and Description
interface	CompletedTask Represents a completed Task.
class	FailedTask An error message that REEF Driver gets from a failed Task.
interface	RunningTask Represents a running Task.
interface	SuspendedTask Represents a suspended Task.
class	TaskConfigurationOptions Configuration parameters for the TaskConfiguration class.
interface	TaskMessage A message from a running task to the driver.

Uses of Public in org.apache.reef.evaluator.context

Classes in org.apache.reef.evaluator.context with annotations of type Public

Modifier and Type	Class and Description
class	ContextMessage Evaluator-side representation of a message sent from an Evaluator to a Driver.
interface	ContextMessageHandler Implement this interface to receive messages from the driver in a context.
interface	ContextMessageSource Message source for control flow messages from a context to the Driver.

Uses of Public in org.apache.reef.evaluator.context.events

Classes in org.apache.reef.evaluator.context.events with annotations of type Public

Modifier and Type	Interface and Description
interface	ContextStart This Event is fired when a Context is started.
interface	ContextStop This event is fired when a Context is about to be closed.

Uses of Public in org.apache.reef.io

Classes in org.apache.reef.io with annotations of type Public

Modifier and Type	Interface and Description
interface	Message A message from a REEF component.

Uses of Public in org.apache.reef.io.checkpoint.fs

Classes in org.apache.reef.io.checkpoint.fs with annotations of type Public

Modifier and Type	Class and Description
class	FSCheckPointServiceConfiguration ConfigurationModule for the FSCheckPointService.

Uses of Public in org.apache.reef.io.naming

Classes in org.apache.reef.io.naming with annotations of type Public

Modifier and Type	Interface and Description
interface	NamingLookup Implementations of this interface facilitate address lookups based on Identifiers.

Uses of Public in org.apache.reef.runtime.mesos.client

Classes in org.apache.reef.runtime.mesos.client with annotations of type Public

Modifier and Type	Class and Description
class	MesosClientConfiguration A ConfigurationModule for the Mesos resource manager.

Uses of Public in org.apache.reef.runtime.yarn.client

Classes in org.apache.reef.runtime.yarn.client with annotations of type Public

Modifier and Type	Class and Description
class	YarnClientConfiguration A ConfigurationModule for the YARN resourcemanager.
class	YarnDriverConfiguration Additional YARN-Specific configuration options to be merged with DriverConfiguration.

Uses of Public in org.apache.reef.runtime.yarn.driver

Classes in org.apache.reef.runtime.yarn.driver with annotations of type Public

Modifier and Type	Interface and Description
interface	RackNameFormatter Provides a method to retrieve the rack name from a container, which may be dependent on the Hadoop distribution.
class	YarnDriverRestartConfiguration Use this ConfigurationModule to configure YARN-specific Restart options for the driver.

Uses of Public in org.apache.reef.task

Classes in org.apache.reef.task with annotations of type Public

Modifier and Type	Class and Description
class	HeartBeatTriggerManager Helper class for immediately sending heartbeat messages.
interface	Task The interface for Tasks.
class	TaskMessage A message sent from a Task to a Driver.
interface	TaskMessageSource Message source for control flow messages from a task to the Driver.

Uses of Public in org.apache.reef.task.events

Classes in org.apache.reef.task.events with annotations of type Public

Modifier and Type	Interface and Description
interface	CloseEvent Indicates that the driver called .close() on this Task.
interface	DriverMessage Represents a message sent by the driver.
interface	SuspendEvent Event fired when the driver called suspend() on this task.
interface	TaskStart Represents a TaskStart.
interface	TaskStop Represents a Task stop.

Uses of Public in org.apache.reef.tests

Classes in org.apache.reef.tests with annotations of type Public

Modifier and Type	Class and Description
class	TestDriverLauncher A launcher for REEF Drivers.

Uses of Public in org.apache.reef.vortex.api

Classes in org.apache.reef.vortex.api with annotations of type Public

Modifier and Type	Class and Description
class	AggregateResult<TInput,TOutput> The result of an aggregate.
class	AggregateResultSynchronous<TInput,TOutput> The synchronous result of an aggregate, returned by VortexAggregateFuture.get().
interface	VortexAggregateFunction<TOutput> Typed user function for Local Aggregation.
class	VortexAggregateFuture<TInput,TOutput> The interface between user code and aggregation Tasklets.
class	VortexAggregatePolicy The policy for local aggregation on the VortexWorkers.