tibrvcmTransport_ReviewLedger()

Function

Declaration

tibrv_status tibrvcmTransport_ReviewLedger(
    tibrvcmTransport         cmTransport,
    tibrvcmReviewCallback    callback,
    const char*              subject,
    const void*              closure);

Purpose

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

Remarks

The callback function 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 function separately for each matching subject—once for FOO.BAR, once for FOO.BAZ, and once for FOO.BOX.

However, if the callback function 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 function.

For information about the content and format of the callback messages, see tibrvcmReviewCallback.

Parameter	Description
cmTransport	Review the ledger of this transport.
callback	This function 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 function receives a separate message for each matching subject in the ledger.
closure	Pass this closure data to the callback function.

See Also

tibrvcmReviewCallback