org.apache.storm.mqtt.spout

Class MqttSpout

java.lang.Object

org.apache.storm.mqtt.spout.MqttSpout

All Implemented Interfaces:

Serializable, ISpout, IComponent, IRichSpout, org.fusesource.mqtt.client.Listener

public class MqttSpout
extends Object
implements IRichSpout, org.fusesource.mqtt.client.Listener

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected SpoutOutputCollector	collector
protected TopologyContext	context
protected LinkedBlockingQueue<org.apache.storm.mqtt.spout.AckableMessage>	incoming
protected KeyStoreLoader	keyStoreLoader
protected MqttOptions	options
protected HashMap<Long,org.apache.storm.mqtt.spout.AckableMessage>	pending
protected MqttMessageMapper	type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MqttSpout()
	MqttSpout(MqttMessageMapper type, MqttOptions options)
	MqttSpout(MqttMessageMapper type, MqttOptions options, KeyStoreLoader keyStoreLoader)

Method Summary

Modifier and Type	Method and Description
void	ack(Object msgId) Storm has determined that the tuple emitted by this spout with the msgId identifier has been fully processed.
void	activate()
void	close()
void	deactivate()
void	declareOutputFields(OutputFieldsDeclarer declarer)
void	fail(Object msgId) The tuple emitted by this spout with the msgId identifier has failed to be fully processed.
Map<String,Object>	getComponentConfiguration()
void	nextTuple() When this method is called, Storm is requesting that the Spout emit tuples to the output collector.
void	onConnected()
void	onDisconnected()
void	onFailure(Throwable throwable)
void	onPublish(org.fusesource.hawtbuf.UTF8Buffer topic, org.fusesource.hawtbuf.Buffer payload, Runnable ack)
void	open(Map conf, TopologyContext context, SpoutOutputCollector collector)

Methods inherited from class java.lang.Object

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

Field Detail

collector

protected transient SpoutOutputCollector collector

context

protected transient TopologyContext context

incoming

protected transient LinkedBlockingQueue<org.apache.storm.mqtt.spout.AckableMessage> incoming

pending

protected transient HashMap<Long,org.apache.storm.mqtt.spout.AckableMessage> pending

type

protected MqttMessageMapper type

options

protected MqttOptions options

keyStoreLoader

protected KeyStoreLoader keyStoreLoader

Constructor Detail

MqttSpout

protected MqttSpout()

MqttSpout

public MqttSpout(MqttMessageMapper type,
                 MqttOptions options)

MqttSpout

public MqttSpout(MqttMessageMapper type,
                 MqttOptions options,
                 KeyStoreLoader keyStoreLoader)

Method Detail

declareOutputFields

public void declareOutputFields(OutputFieldsDeclarer declarer)

Specified by:

declareOutputFields in interface IComponent

getComponentConfiguration

public Map<String,Object> getComponentConfiguration()

Specified by:

getComponentConfiguration in interface IComponent

open

public void open(Map conf,
                 TopologyContext context,
                 SpoutOutputCollector collector)

Specified by:

open in interface ISpout

close

public void close()

Specified by:

close in interface ISpout

activate

public void activate()

Specified by:

activate in interface ISpout

deactivate

public void deactivate()

Specified by:

deactivate in interface ISpout

nextTuple

public void nextTuple()

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.

Specified by:

nextTuple in interface ISpout

ack

public void ack(Object msgId)

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

Parameters:

msgId -

fail

public void fail(Object msgId)

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

Parameters:

msgId -

onConnected

public void onConnected()

Specified by:

onConnected in interface org.fusesource.mqtt.client.Listener

onDisconnected

public void onDisconnected()

Specified by:

onDisconnected in interface org.fusesource.mqtt.client.Listener

onPublish

public void onPublish(org.fusesource.hawtbuf.UTF8Buffer topic,
                      org.fusesource.hawtbuf.Buffer payload,
                      Runnable ack)

Specified by:

onPublish in interface org.fusesource.mqtt.client.Listener

onFailure

public void onFailure(Throwable throwable)

Specified by:

onFailure in interface org.fusesource.mqtt.client.Listener