TibrvCmListener::destroy()

Method

Declaration

TibrvStatus destroy(
    tibrv_bool cancelAgreements,
    TibrvEventOnComplete* completeCB = NULL);

Purpose

Destroy a certified delivery listener.

Parameter

Description

cancelAgreements

TIBRV_TRUE cancels all certified delivery agreements of this listener; certified senders delete from their ledgers all messages sent to this listener.

TIBRV_FALSE leaves all certified delivery agreements in effect, so certified senders continue to store messages.

Canceling Agreements

When destroying a certified delivery listener, a program can either cancel its certified delivery agreements with senders, or let those agreements persist (so a successor listener can receive the messages covered by those agreements).

When canceling agreements, each (previously) certified sender transport receives a REGISTRATION.CLOSED advisory. Successor listeners cannot receive old messages.

See Also

TibrvEventOnComplete

TibrvCmListener