[docs] Document Alarm thread-safety guarantees (#34092)

This commit is contained in:
AJ Heller 2023-08-17 10:52:36 -07:00 committed by GitHub
parent c21e3f1867
commit 724ef464b2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions

View File

@ -38,6 +38,11 @@ namespace grpc {
/// The \a Alarm API has separate \a Set methods for CompletionQueues and
/// callbacks, but only one can be used at any given time. After an alarm has
/// been triggered or cancelled, the same Alarm object may reused.
///
/// Alarm methods are not thread-safe. Applications must ensure a strict
/// ordering between calls to \a Set and \a Cancel. This also implies that any
/// cancellation that occurs before the alarm has been set will have no effect
/// on any future \a Set calls.
class Alarm : private grpc::internal::GrpcLibrary {
public:
/// Create an unset Alarm.