BloombergLP::bdlmt::TimerEventScheduler::cancelEvent

Same as the preceding overload, with the specified key.

Synopsis

Declared in <bdlmt_timereventscheduler.h>

int
cancelEvent(
    Handle handle,
    EventKey const& key,
    bool wait = false);

Return Value

0 on successful cancellation, and a non-zero value otherwise

Parameters

NameDescription
handleidentifier of the event to cancel
keykey uniquely identifying the event
waitif true, wait until the dispatcher has resumed