[EventEngine] API contract: Endpoint::Read will provide either an error or data, but never both

pull/38019/head
AJ Heller 5 months ago
parent 2329b25b09
commit 9da1fe360a
  1. 6
      include/grpc/event_engine/event_engine.h

@ -194,9 +194,9 @@ class EventEngine : public std::enable_shared_from_this<EventEngine>,
/// on_read callback is not executed. Otherwise it returns false and the \a
/// on_read callback executes asynchronously when the read completes. The
/// caller must ensure that the callback has access to the buffer when it
/// executes. Ownership of the buffer is not transferred. Valid slices *may*
/// be placed into the buffer even if the callback is invoked with a non-OK
/// Status.
/// executes. Ownership of the buffer is not transferred. Either an error is
/// passed to the callback (like socket closed), or valid data is available
/// in the buffer, but never both at the same time.
///
/// There can be at most one outstanding read per Endpoint at any given
/// time. An outstanding read is one in which the \a on_read callback has

Loading…
Cancel
Save