org.apache.storm.spout

Class SpoutOutputCollector

java.lang.Object

org.apache.storm.spout.SpoutOutputCollector

All Implemented Interfaces:

ISpoutOutputCollector

public class SpoutOutputCollector
extends java.lang.Object
implements ISpoutOutputCollector

Constructor Summary

Constructors

Constructor and Description
SpoutOutputCollector(java.lang.String spoutId, TaskContext taskContext, EdgeFieldMap outFieldsForEdge, EdgeFieldMap keyedOutEdges) Initializes a SpoutOutputCollector

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Integer>	emit(java.util.List<java.lang.Object> tuple) Emits a tuple to the default output stream with a null message id.
java.util.List<java.lang.Integer>	emit(java.util.List<java.lang.Object> tuple, java.lang.Object messageId) Emits a new tuple to the default output stream with the given message ID.
java.util.List<java.lang.Integer>	emit(java.lang.String streamId, java.util.List<java.lang.Object> tuple, java.lang.Object messageId) Returns the task ids that received the tuples.
void	emitDirect(int taskId, java.lang.String streamId, java.util.List<java.lang.Object> tuple, java.lang.Object messageId)
void	reportError(java.lang.Throwable error)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpoutOutputCollector

public SpoutOutputCollector(java.lang.String spoutId,
                            TaskContext taskContext,
                            EdgeFieldMap outFieldsForEdge,
                            EdgeFieldMap keyedOutEdges)

Initializes a SpoutOutputCollector

Parameters:

taskContext - the instance of twister2 task context

Method Detail

emit

public java.util.List<java.lang.Integer> emit(java.util.List<java.lang.Object> tuple)

Emits a tuple to the default output stream with a null message id. Storm will not track this message so ack and fail will never be called for this tuple. The emitted values must be immutable.

emit

public java.util.List<java.lang.Integer> emit(java.util.List<java.lang.Object> tuple,
                                              java.lang.Object messageId)

Emits a new tuple to the default output stream with the given message ID. When Storm detects that this tuple has been fully processed, or has failed to be fully processed, the spout will receive an ack or fail callback respectively with the messageId as long as the messageId was not null. If the messageId was null, Storm will not track the tuple and no callback will be received. Note that Storm's event logging functionality will only work if the messageId is serializable via Kryo or the Serializable interface. The emitted values must be immutable.

Returns:

the list of task ids that this tuple was sent to

emit

public java.util.List<java.lang.Integer> emit(java.lang.String streamId,
                                              java.util.List<java.lang.Object> tuple,
                                              java.lang.Object messageId)

Description copied from interface: ISpoutOutputCollector

Returns the task ids that received the tuples.

Specified by:

emit in interface ISpoutOutputCollector

emitDirect

public void emitDirect(int taskId,
                       java.lang.String streamId,
                       java.util.List<java.lang.Object> tuple,
                       java.lang.Object messageId)

Specified by:

emitDirect in interface ISpoutOutputCollector

reportError

public void reportError(java.lang.Throwable error)

Specified by:

reportError in interface ISpoutOutputCollector