BubbleQueueLength
(Engine-Level Function)
Description: | Reports the length of the queue of messages from the current bubble's parent bubble or one of its children. |
Returns: | Numeric |
Usage: | Steady State only. |
Function Groups: | Bubble and Thread |
Related to: | Bubble | BubbleList | BubbleReceive | BubbleSend | RunInBubble |
Format: | BubbleQueueLength([BubbleHandle, QueueName]) |
Parameters: |
BubbleHandle |
Optional bubble handle as returned by the Bubble and BubbleList functions. Specifies the bubble where the message is being received from. If Invalid or not provided, the message is being received from the parent bubble. |
QueueName |
Optional text. The name of the queue that the message was queued on. If not provided, it defaults to the empty string, “”. Any time you specify a new string, a new queue will be created internally. |
Example:
Refer to the example in the Bubble function description.