BloombergLP::bdlmt::TimerEventScheduler::cancelEvent

cancelEvent overloads

Synopses

Declared in <bdlmt_timereventscheduler.h>

Cancel the event identified by the specified handle.

int
cancelEvent(
    Handle handle,
    bool wait = false);

Same as the preceding overload, with the specified key.

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

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

Name

Description

handle

identifier of the event to cancel

wait

if true, wait until the dispatcher has resumed

key

key uniquely identifying the event

Created with MrDocs