BloombergLP::bdlmt::EventScheduler::cancelEvent

Cancel the event referred to by handle and release the handle.

Synopsis

Declared in <bdlmt_eventscheduler.h>

int
cancelEvent(EventHandle* handle);

Description

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.

Return Value

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

Parameters

NameDescription
handleevent handle to cancel and release