[EventEngine] Document RunAfter can return an invalid handle for immediate execution (#36072)

Closes #36072

COPYBARA_INTEGRATE_REVIEW=https://github.com/grpc/grpc/pull/36072 from drfloob:docs/runafter-immediate-invalid-handle 4ce2dd7dd1
PiperOrigin-RevId: 613737590
pull/36087/head
AJ Heller 9 months ago committed by Copybara-Service
parent 3032b5c48d
commit ad7fbc1e92
  1. 3
      include/grpc/event_engine/event_engine.h

@ -444,6 +444,9 @@ class EventEngine : public std::enable_shared_from_this<EventEngine>,
///
/// Implementations must not execute the closure in the calling thread before
/// \a RunAfter returns.
///
/// Implementations may return a \a kInvalid handle if the callback can be
/// immediately executed, and is therefore not cancellable.
virtual TaskHandle RunAfter(Duration when, Closure* closure) = 0;
/// Synonymous with scheduling an alarm to run after duration \a when.
///

Loading…
Cancel
Save