cancelEvent overloads

Synopses

Declared in <bdlmt_timereventscheduler.h>

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.

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

» more...

Same as the preceding overload, with the specified key.

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

» more...

Created with MrDocs