Package org.apache.storm.topology.base
Class BaseRichSpout
java.lang.Object
org.apache.storm.topology.base.BaseComponent
org.apache.storm.topology.base.BaseRichSpout
- All Implemented Interfaces:
- Serializable,- ISpout,- IComponent,- IRichSpout
- Direct Known Subclasses:
- AnchoredWordCount.RandomSentenceSpout,- BlobStoreAPIWordCountTopology.RandomSentenceSpout,- CheckpointSpout,- ConstSpout,- DRPCSpout,- ExclamationTopology.FixedOrderWordSpout,- FastWordCountTopology.FastRandomSentenceSpout,- FeederSpout,- FileReadSpout,- HdfsFileTopology.SentenceSpout,- HdfsSpout,- IncrementingSpout,- InOrderDeliveryTest.InOrderSpout,- JmsSpout,- KafkaSpout,- LambdaSpout,- LoadSpout,- MasterBatchCoordinator,- RandomIntegerSpout,- RandomSentenceSpout,- SequenceFileTopology.SentenceSpout,- SpoutTracker,- StringGenSpout,- TestEventLogSpout,- TestPlannerSpout,- TestWordSpout,- TimeDataIncrementingSpout,- WordGenSpout
- See Also:
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidStorm has determined that the tuple emitted by this spout with the msgId identifier has been fully processed.voidactivate()Called when a spout has been activated out of a deactivated mode.voidclose()Called when an ISpout is going to be shutdown.voidCalled when a spout has been deactivated.voidThe tuple emitted by this spout with the msgId identifier has failed to be fully processed.Methods inherited from class org.apache.storm.topology.base.BaseComponentgetComponentConfigurationMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.storm.topology.IComponentdeclareOutputFields, getComponentConfiguration
- 
Constructor Details- 
BaseRichSpoutpublic BaseRichSpout()
 
- 
- 
Method Details- 
closepublic void close()Description copied from interface:ISpoutCalled when an ISpout is going to be shutdown. There is no guarentee that close will be called, because the supervisor kill -9's worker processes on the cluster.The one context where close is guaranteed to be called is a topology is killed when running Storm in local mode. 
- 
activatepublic void activate()Description copied from interface:ISpoutCalled when a spout has been activated out of a deactivated mode. nextTuple will be called on this spout soon. A spout can become activated after having been deactivated when the topology is manipulated using the `storm` client.
- 
deactivatepublic void deactivate()Description copied from interface:ISpoutCalled when a spout has been deactivated. nextTuple will not be called while a spout is deactivated. The spout may or may not be reactivated in the future.- Specified by:
- deactivatein interface- ISpout
 
- 
ackDescription copied from interface:ISpoutStorm 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.
- 
failDescription copied from interface:ISpoutThe 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.
 
-