Package org.apache.storm.loadgen

Class LoadSpout

java.lang.Object

org.apache.storm.topology.base.BaseComponent

org.apache.storm.topology.base.BaseRichSpout

org.apache.storm.loadgen.LoadSpout

All Implemented Interfaces:

Serializable, ISpout, IComponent, IRichSpout

Direct Known Subclasses:

ThroughputVsLatency.FastRandomSentenceSpout

public class LoadSpout
extends BaseRichSpout

A spout that simulates a real world spout based off of statistics about it.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
LoadSpout(double ratePerSecond)	Create a simple load spout with just a set rate per second on the default stream.
LoadSpout(LoadCompConf conf)

Method Summary

Modifier and Type	Method	Description
void	ack(Object id)	Storm has determined that the tuple emitted by this spout with the msgId identifier has been fully processed.
void	declareOutputFields(OutputFieldsDeclarer declarer)	Declare the output schema for all the streams of this topology.
void	fail(Object id)	The tuple emitted by this spout with the msgId identifier has failed to be fully processed.
protected Values	getNextValues(OutputStreamEngine se)
void	nextTuple()	When this method is called, Storm is requesting that the Spout emit tuples to the output collector.
void	open(Map<String,Object> conf, TopologyContext context, SpoutOutputCollector collector)	Called when a task for this component is initialized within a worker on the cluster.

Methods inherited from class org.apache.storm.topology.base.BaseRichSpout

activate, close, deactivate

Methods inherited from class org.apache.storm.topology.base.BaseComponent

getComponentConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.storm.topology.IComponent

getComponentConfiguration

Constructor Detail

LoadSpout

public LoadSpout(double ratePerSecond)

Create a simple load spout with just a set rate per second on the default stream.

Parameters:

ratePerSecond - the rate to send messages at.

LoadSpout

public LoadSpout(LoadCompConf conf)

Method Detail

open

public void open(Map<String,Object> conf,
                 TopologyContext context,
                 SpoutOutputCollector collector)

Description copied from interface: ISpout

Called when a task for this component is initialized within a worker on the cluster. It provides the spout with the environment in which the spout executes.

This includes the:

Parameters:

conf - The Storm configuration for this spout. This is the configuration provided to the topology merged in with cluster configuration on this machine.

context - This object can be used to get information about this task's place within the topology, including the task id and component id of this task, input and output information, etc.

collector - The collector is used to emit tuples from this spout. Tuples can be emitted at any time, including the open and close methods. The collector is thread-safe and should be saved as an instance variable of this spout object.

nextTuple

public void nextTuple()

Description copied from interface: ISpout

When this method is called, Storm is requesting that the Spout emit tuples to the output collector. This method should be non-blocking, so if the Spout has no tuples to emit, this method should return. nextTuple, ack, and fail are all called in a tight loop in a single thread in the spout task. When there are no tuples to emit, it is courteous to have nextTuple sleep for a short amount of time (like a single millisecond) so as not to waste too much CPU.

getNextValues

protected Values getNextValues(OutputStreamEngine se)

declareOutputFields

public void declareOutputFields(OutputFieldsDeclarer declarer)

Description copied from interface: IComponent

Declare the output schema for all the streams of this topology.

Parameters:

declarer - this is used to declare output stream ids, output fields, and whether or not each output stream is a direct stream

ack

public void ack(Object id)

Description copied from interface: ISpout

Storm has determined that the tuple emitted by this spout with the msgId identifier has been fully processed. Typically, an implementation of this method will take that message off the queue and prevent it from being replayed.

Specified by:

ack in interface ISpout

Overrides:

ack in class BaseRichSpout

fail

public void fail(Object id)

Description copied from interface: ISpout

The tuple emitted by this spout with the msgId identifier has failed to be fully processed. Typically, an implementation of this method will put that message back on the queue to be replayed at a later time.

Specified by:

fail in interface ISpout

Overrides:

fail in class BaseRichSpout