ReviewLedgerDelegate

Delegate

Visual Basic

Public Delegate Function ReviewLedgerDelegate(
    ByVal cmTransport As CMTransport,
    ByVal subject As String,
    ByVal message As Message,
    ByVal closure As Object )
  As Boolean

C#

public delegate bool ReviewLedgerDelegate(
    CMTransport cmTransport,
    string subject,
    Message message,
    object closure)

Purpose

Programs define this delegate to process ledger review messages.

Remarks

CMTransport.ReviewLedger calls this callback method once for each matching subject stored in the ledger.

To continue reviewing the ledger, return false from this callback method. To stop reviewing the ledger, return true from this callback method; CMTransport.ReviewLedger cancels the review and returns immediately.

Parameter

Description
cmTransport

This parameter receives the transport.
subject

This parameter receives the subject for this ledger item.
message

This parameter receives a summary message describing the delivery status of messages in the ledger. The table below describes the fields of the summary message.
closure

This parameter receives closure data that the program supplied to CMTransport.ReviewLedger.

Review Message

The following table presents the fields that review messages can contain.

Field Name

Description
subject

The subject that this message summarizes.

This field has (wire format) datatype TIBRVMSG_MSG.
seqno_last_sent

The sequence number of the most recent message sent with this subject name.

This field has (wire format) datatype TIBRVMSG_U64.
total_msgs

The total number of messages stored at this subject name.

This field has (wire format) datatype TIBRVMSG_U32.
total_size

The total storage (in bytes) occupied by all messages with this subject name.

If the ledger contains several messages with this subject name, then this field sums the storage space over all of them.

This field has (wire format) datatype TIBRVMSG_U64.
listener

Each summary message can contain one or more fields named listener. Each listener field contains a nested submessage with details about a single registered listener.

This field has (wire format) datatype TIBRVMSG_MSG.
listener.name

Within each listener submessage, the name field contains the name of the listener transport.

This field has (wire format) datatype TIBRVMSG_STRING.
listener.last_confirmed

Within each listener submessage, the last_confirmed field contains the sequence number of the last message for which the listener confirmed delivery.

This field has (wire format) datatype TIBRVMSG_U64.

See Also

CMTransport.ReviewLedger