org.apache.spark.streaming.receiver

Class ActorReceiver<T>

Object

org.apache.spark.streaming.receiver.Receiver<T>

org.apache.spark.streaming.receiver.ActorReceiver<T>

All Implemented Interfaces:

java.io.Serializable, Logging

public class ActorReceiver<T>
extends Receiver<T>
implements Logging

Provides Actors as receivers for receiving stream.

As Actors can also be used to receive data from almost any stream source. A nice set of abstraction(s) for actors as receivers is already provided for a few general cases. It is thus exposed as an API where user may come with their own Actor to run as receiver for Spark Streaming input source.

This starts a supervisor actor which starts workers and also provides [http://doc.akka.io/docs/akka/snapshot/scala/fault-tolerance.html fault-tolerance].

Here's a way to start more supervisor/workers as its children.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ActorReceiver.Supervisor

Constructor Summary

Constructors

Constructor and Description
ActorReceiver(akka.actor.Props props, String name, StorageLevel storageLevel, akka.actor.SupervisorStrategy receiverSupervisorStrategy, scala.reflect.ClassTag<T> evidence$1)

Method Summary

Methods

Modifier and Type	Method and Description
void	onStart() This method is called by the system when the receiver is started.
void	onStop() This method is called by the system when the receiver is stopped.

Methods inherited from class org.apache.spark.streaming.receiver.Receiver

attachExecutor, executor_, isStarted, isStopped, preferredLocation, reportError, restart, restart, restart, setReceiverId, stop, stop, storageLevel, store, store, store, store, store, store, store, store, store, streamId

Methods inherited from class Object

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

Methods inherited from interface org.apache.spark.Logging

initializeIfNecessary, initializeLogging, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Constructor Detail

ActorReceiver

public ActorReceiver(akka.actor.Props props,
             String name,
             StorageLevel storageLevel,
             akka.actor.SupervisorStrategy receiverSupervisorStrategy,
             scala.reflect.ClassTag<T> evidence$1)

Method Detail

onStart

public void onStart()

Description copied from class: Receiver

This method is called by the system when the receiver is started. This function must initialize all resources (threads, buffers, etc.) necessary for receiving data. This function must be non-blocking, so receiving the data must occur on a different thread. Received data can be stored with Spark by calling store(data).

If there are errors in threads started here, then following options can be done (i) reportError(...) can be called to report the error to the driver. The receiving of data will continue uninterrupted. (ii) stop(...) can be called to stop receiving data. This will call onStop() to clear up all resources allocated (threads, buffers, etc.) during onStart(). (iii) restart(...) can be called to restart the receiver. This will call onStop() immediately, and then onStart() after a delay.

Specified by:

onStart in class Receiver<T>

onStop

public void onStop()

Description copied from class: Receiver

This method is called by the system when the receiver is stopped. All resources (threads, buffers, etc.) setup in onStart() must be cleaned up in this method.

Specified by:

onStop in class Receiver<T>