Cancel the recurring clock identified by the specified handle.

Synopsis

Declared in <bdlmt_timereventscheduler.h>

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

Description

Cancel the clock having the specified handle. If the optionally specified wait is true, then ensure that any scheduled event for the clock having handle is either cancelled or has been dispatched before this call returns. Return 0 on success, and a non‐zero value if the handle is invalid. If this method is being invoked from the dispatcher thread, then the wait is ignored to avoid deadlock.

Return Value

0 on success, and a non‐zero value if handle is invalid

Parameters

Name

Description

handle

identifier of the clock to cancel

wait

if true, wait until the clock is cancelled or dispatched

Created with MrDocs