Collapse All Expand All | Language Filter: C#Language Filter: Visual Basic Language Filter: Visual C++ C# Visual Basic Visual C++ | See Also
StreamBase Client API
StreamBaseClient..::Dequeue Method (Int32)

Dequeue a batch of tuples from a subscribed stream. This method will block until:

- at least one tuple is available on any subscribed stream (DequeueResult.Status==GOOD), or
- nTimeoutMS milliseconds have elapsed (DequeueResult.Status==TIMEOUT), or
- the node is shut down (DequeueResult.Status==CLOSED), or
- a network error occurs(StreamBaseException is thrown)

An nTimeoutMS of zero will block indefinitely, or until a tuple arrives. Note that the actual dequeue timeout may vary based on normal thread scheduling, plus network interactions with the server.

If the request times out or the node is shut down and no Tuples have been dequeued, the returned DequeueResult object will contain 0 Tuples and its Status property will be DequeueResult.TIMEOUT or DequeueResult.CLOSED, respectively.

Note:
The DequeueResult will only contain valid data until Dequeue() is called again.

Namespace: StreamBase.SB.Client
Assembly: StreamBase.SB.Client (in StreamBase.SB.Client.dll) Version: 10.3.0.0

# Syntax

| C# |  |  | Visual Basic |  |  | Visual C++ |

    public DequeueResult Dequeue(
    	int nTimeoutMS
    )

    Public Function Dequeue ( _
    	nTimeoutMS As Integer _
    ) As DequeueResult

    public:
    DequeueResult^ Dequeue(
    	int nTimeoutMS
    )

#### Parameters

nTimeoutMS
  Int32
  the number of milliseconds to wait before returning if no Tuples arrives

#### Return Value

a DequeueResult containing the results of the operation

# Exceptions

Exception | Condition
--- | ---
StreamBase.SB..::..StreamBaseException | General problem occurred

# See Also

StreamBaseClient Class
Dequeue Overload
StreamBase.SB.Client Namespace
StreamBase.SB.Client.DequeueResult