org.apache.spark.streaming.flume

Class FlumeReceiver

Object

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

org.apache.spark.streaming.flume.FlumeReceiver

All Implemented Interfaces:

java.io.Serializable, Logging

public class FlumeReceiver
extends Receiver<SparkFlumeEvent>
implements Logging

A NetworkReceiver which listens for events using the Flume Avro interface.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FlumeReceiver.CompressionChannelPipelineFactory A Netty Pipeline factory that will decompress incoming data from and the Netty client and compress data going back to the client.

Constructor Summary

Constructors

Constructor and Description
FlumeReceiver(String host, int port, StorageLevel storageLevel, boolean enableDecompression)

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.
scala.Some<String>	preferredLocation() Override this to specify a preferred location (hostname).
org.apache.avro.ipc.specific.SpecificResponder	responder()
org.apache.avro.ipc.NettyServer	server()

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

attachExecutor, executor_, isStarted, isStopped, 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

FlumeReceiver

public FlumeReceiver(String host,
             int port,
             StorageLevel storageLevel,
             boolean enableDecompression)

Method Detail

responder

public org.apache.avro.ipc.specific.SpecificResponder responder()

server

public org.apache.avro.ipc.NettyServer server()

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<SparkFlumeEvent>

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<SparkFlumeEvent>

preferredLocation

public scala.Some<String> preferredLocation()

Description copied from class: Receiver

Override this to specify a preferred location (hostname).

Overrides:

preferredLocation in class Receiver<SparkFlumeEvent>