qpid::client::FlowControl Struct Reference

Flow control works by associating a finite amount of "credit" associated with a subscription. More...

#include <FlowControl.h>

List of all members.

Public Member Functions

 FlowControl (uint32_t messages_=0, uint32_t bytes_=0, bool window_=false)
bool operator== (const FlowControl &x)

Static Public Member Functions

static FlowControl messageCredit (uint32_t messages_)
static FlowControl messageWindow (uint32_t messages_)
static FlowControl byteCredit (uint32_t bytes_)
static FlowControl byteWindow (uint32_t bytes_)
static FlowControl unlimited ()
static FlowControl zero ()

Public Attributes

uint32_t messages
 Message credit: subscription can accept up to this many messages.
uint32_t bytes
 Byte credit: subscription can accept up to this many bytes of message content.
bool window
 Window mode.

Static Public Attributes

static const uint32_t UNLIMITED = 0xFFFFFFFF


Detailed Description

Flow control works by associating a finite amount of "credit" associated with a subscription.

Credit includes a message count and a byte count. Each message received decreases the message count by one, and the byte count by the size of the message. Either count can have the special value UNLIMITED which is never decreased.

A subscription's credit is exhausted when the message count is 0 or the byte count is too small for the next available message. The subscription will not receive any further messages until is credit is renewed.

In "window mode" credit is automatically renewed when a message is acknowledged (

See also:
AckPolicy) In non-window mode credit is not automatically renewed, it must be explicitly re-set (

SubscriptionManager)

Definition at line 47 of file FlowControl.h.


Member Data Documentation

Message credit: subscription can accept up to this many messages.

Definition at line 60 of file FlowControl.h.

Byte credit: subscription can accept up to this many bytes of message content.

Definition at line 62 of file FlowControl.h.

Window mode.

If true credit is automatically renewed as messages are acknowledged.

Definition at line 64 of file FlowControl.h.


The documentation for this struct was generated from the following file:

Generated on Thu Oct 16 13:38:19 2008 for Qpid by  doxygen 1.5.6