cancelEvent overloads
Synopses
Declared in <bdlmt_eventscheduler.h>
Cancel the event having the specified handle and release the handle. Return 0 on successful cancellation, and a non‐zero value if the handle is invalid or if the event has already been dispatched or canceled. Note that handle is released whether this call is successful or not.
int
cancelEvent(EventHandle* handle);Same as the preceding overload, for a recurring‐event handle.
int
cancelEvent(RecurringEventHandle* handle);Cancel the event having the specified handle. Return 0 on successful cancellation, and a non‐zero value if the handle is invalid or if the event has already been dispatched or canceled. Note that due to the implicit conversion from Handle types, these methods also match the following: ` int cancelEvent(const EventHandle& handle); int cancelEvent(const RecurringEventHandle& handle); ` Compared to the version taking a pointer to Handle, the managed reference to the event is not released until the Handle goes out of scope.
int
cancelEvent(Event const* handle);Same as the preceding overload, for a recurring event.
int
cancelEvent(RecurringEvent const* handle);Created with MrDocs