Encapsulates the data returned from a dequeue() operation.
Contains a stream name and a list of Tuples.
Namespace: StreamBase.SB.ClientAssembly: StreamBase.SB.Client (in StreamBase.SB.Client.dll) Version: 7.6.0.0
Syntax
C# | Visual Basic | Visual C++ |
public class DequeueResult : ICloneable, IEnumerable, IDisposable
Public Class DequeueResult _ Implements ICloneable, IEnumerable, IDisposable
public ref class DequeueResult : ICloneable, IEnumerable, IDisposable
Members
All Members | Constructors ![]() | Fields ![]() | Properties ![]() | Methods ![]() |
![]() ![]() | ![]() ![]() ![]() | ![]() ![]() | ![]() ![]() ![]() ![]() |
Member | Description | |
---|---|---|
![]() | DequeueResult(DequeueResult, array<Tuple>[]()[][]) |
Construct a new DequeueResult using the specified list of tuples. A copy of the provided tuples will be made.
This may be useful when writing DequeueResult..::..Interceptor implementations.
|
![]() | DequeueResult(DequeueResult, IList<(Of <<'(Tuple>)>>)) |
Construct a new DequeueResult using the specified list of tuples. A copy of the provided tuples will be made.
This may be useful when writing DequeueResult..::..Interceptor implementations.
|
![]() | Clone()()()() |
Clone this DequeueResult
|
![]() ![]() | CLOSED |
Dequeue operation failed because the connection was closed.
|
![]() | CurrentLeadershipStatus |
Gets the leadership status of the server that produced this DequeueResult.
|
![]() | Equals(Object) | (Inherited from Object.) |
![]() | GetEnumerator()()()() |
Implements IEnumerable. This allows DequeueResult to be used in a foreach loop
to enumerate its Tuples, like this:
![]() DequeueResult dr = myStreamBaseClient.Dequeue(); foreach (Tuple tuple in dr) (...) |
![]() | GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetLeadershipStatus()()()() |
Returns the StreamBaseURI of the server that produced this DequeueResult.
|
![]() | GetServerURI()()()() |
Returns the StreamBaseURI of the server that produced this DequeueResult.
|
![]() | GetStatus()()()() |
Return the status of this DequeueResult. DequeueResult.GOOD means the DequeueResult contains
tuples.
|
![]() | GetStreamName()()()() |
Returns the name of the stream on which tuples were dequeued.
|
![]() | GetStreamProperties()()()() |
Return the StreamProperties for this DequeueResult
|
![]() | GetTupleCount()()()() |
Returns the number of tuples dequeued.
|
![]() | GetType()()()() | Gets the Type of the current instance. (Inherited from Object.) |
![]() ![]() | GOOD |
Dequeue operation succeeded.
|
![]() | Item[([( Int32])]) | |
![]() | ServerURI |
The StreamBaseURI of the server that produced this DequeueResult.
|
![]() | Status |
Gets the status of this DequeueResult. DequeueResult.GOOD means the DequeueResult contains
tuples.
|
![]() | StreamProperties | StreamProperties for this DequeueResult
|
![]() ![]() | SUPPRESSED |
This can be returned by DequeueResult..::..Interceptor implementations to signify that
the tuples should not be returned to the caller.
|
![]() ![]() | TIMEOUT |
Dequeue operation timed out.
|
![]() | ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
![]() ![]() | UNINITIALIZED |
Dequeue operation has not yet been attempted.
|