TibrvCmTransport::reviewLedger()

Method

Declaration

TibrvStatus reviewLedger(
    TibrvCmReviewCallback* reviewCallback,
    const char* subject,
    const void* closure=NULL);

Purpose

Query the ledger for stored items related to a subject name.

Remarks

The callback method receives one message for each matching subject of outbound messages stored in the ledger. For example, when FOO.* is the subject, TibrvCmTransport::reviewLedger() calls its callback method separately for each matching subject—once for FOO.BAR, once for FOO.BAZ, and once for FOO.BOX.

However, if the callback method returns non-NULL, then TibrvCmTransport::reviewLedger() returns immediately.

If the ledger does not contain any matching items, TibrvCmTransport::reviewLedger() returns normally without calling the callback method.

For information about the content and format of the callback messages, see TibrvCmReviewCallback::onLedgerMsg().

Parameter	Description
reviewCallback	This object receives the review messages.
subject	Query for items related to this subject name. If this subject contains wildcard characters (* or >), then review all items with matching subject names. The callback method receives a separate message for each matching subject in the ledger.
closure	Pass this closure data to the review callback method.

See Also

TibrvCmReviewCallback::onLedgerMsg()