public abstract class DequeueResult extends java.lang.Object implements java.lang.Iterable<Tuple>
Modifier and Type | Class and Description |
---|---|
static interface |
DequeueResult.Interceptor
A callback interface that can be implemented by an object that is associated with
a StreamBaseClient and which gets used in the course of dequeuing tuples.
|
Modifier and Type | Field and Description |
---|---|
static int |
CLOSED
Status code indicating that the connection was closed
|
static int |
GOOD
Status code indicating a normal dequeue
|
protected Constants.LeadershipStatus |
leadershipStatus |
protected StreamProperties |
props |
protected java.lang.Throwable |
throwable |
static int |
TIMEOUT
Status code indicating a timeout during dequeue
|
Modifier and Type | Method and Description |
---|---|
int |
checkStatus()
Check and return the status of this DequeueResult.
|
Constants.LeadershipStatus |
getLeadershipStatus()
Return the leadership status of the server that produced this dequeue result.
|
Schema |
getSchema()
Returns the schema for the tuples dequeued, may return null
|
StreamBaseURI |
getServerURI()
return the server that produced this DequeueResult.
|
int |
getStatus()
Return the status of this DequeueResult.
|
java.lang.String |
getStreamName()
Returns the name of the stream on which tuples were dequeued.
|
StreamProperties |
getStreamProperties()
Return the StreamProperties for this DequeueResult.
|
abstract int |
getTupleCount()
Returns the number of tuples dequeued.
|
abstract java.util.Iterator<Tuple> |
iterator()
Returns an iterator of all tuples.
|
public static final int GOOD
public static final int TIMEOUT
public static final int CLOSED
protected final StreamProperties props
protected final java.lang.Throwable throwable
protected final Constants.LeadershipStatus leadershipStatus
public java.lang.String getStreamName()
public Schema getSchema()
public StreamProperties getStreamProperties()
public Constants.LeadershipStatus getLeadershipStatus()
public StreamBaseURI getServerURI()
public abstract int getTupleCount()
public abstract java.util.Iterator<Tuple> iterator()
iterator
in interface java.lang.Iterable<Tuple>
public int getStatus()
if need exceptions collected by this DequeueResult
public int checkStatus() throws StreamBaseException
DequeueResult.getStatus()
but will throw any exceptions that this DequeueResult
has collected.StreamBaseException
- if this DequeueResult has collected any exceptions