BloombergLP::bdlmt::TimerEventScheduler::cancelEvent

Cancel the event identified by the specified handle.

Synopsis

Declared in <bdlmt_timereventscheduler.h>

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

Description

Cancel the event having the specified handle. Optionally use the specified key to uniquely identify the event. If the optionally specified wait is true, then ensure that the dispatcher thread has resumed execution before returning. Return 0 on successful cancellation, and a non‐zero value if the handle is invalid or if it is too late to cancel the event. If this method is being invoked from the dispatcher thread then the wait is ignored to avoid deadlock.

Return Value

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

Parameters

Name

Description

handle

identifier of the event to cancel

wait

if true, wait until the dispatcher has resumed

Created with MrDocs