summaryrefslogtreecommitdiff
path: root/src/mongo/db/cancelable_operation_context.h
diff options
context:
space:
mode:
authorjannaerin <golden.janna@gmail.com>2021-04-12 15:03:10 +0000
committerEvergreen Agent <no-reply@evergreen.mongodb.com>2021-04-12 17:02:32 +0000
commit20ce6d7e1734fa0f9f0b3893e8322658cff48efe (patch)
tree36e8c37c596840e326af50f0a0712a1b5771ef2a /src/mongo/db/cancelable_operation_context.h
parent7c4fdf48f8882818e778c3c2931b0e24aa99711d (diff)
downloadmongo-20ce6d7e1734fa0f9f0b3893e8322658cff48efe.tar.gz
SERVER-55323 Fix comment in cancelable_operation_context.h
Diffstat (limited to 'src/mongo/db/cancelable_operation_context.h')
-rw-r--r--src/mongo/db/cancelable_operation_context.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/src/mongo/db/cancelable_operation_context.h b/src/mongo/db/cancelable_operation_context.h
index c3bc2931261..7f51b7bfd38 100644
--- a/src/mongo/db/cancelable_operation_context.h
+++ b/src/mongo/db/cancelable_operation_context.h
@@ -43,8 +43,8 @@ namespace mongo {
class OperationContext;
/**
- * Wrapper class around an OperationContext that calls markKilled(ErrorCodes::CallbackCanceled) when
- * the supplied CancellationToken is canceled.
+ * Wrapper class around an OperationContext that calls markKilled(ErrorCodes::Interrupted) when the
+ * supplied CancellationToken is canceled.
*
* This class is useful for having an OperationContext be interrupted when a CancellationToken is
* canceled. Note that OperationContext::getCancellationToken() is instead useful for having a
@@ -52,10 +52,10 @@ class OperationContext;
* enables bridging between OperationContext interruption and CancellationToken cancellation
* arbitrarily.
*
- * IMPORTANT: Executors are allowed to refuse work. markKilled(ErrorCodes::CallbackCanceled) won't
- * be called when the supplied CancellationToken is canceled if the task executor has already been
- * shut down, for example. Use a task executor bound to the process lifetime if you must guarantee
- * that the OperationContext is interrupted when the CancellationToken is canceled.
+ * IMPORTANT: Executors are allowed to refuse work. markKilled(ErrorCodes::Interrupted) won't be
+ * called when the supplied CancellationToken is canceled if the task executor has already been shut
+ * down, for example. Use a task executor bound to the process lifetime if you must guarantee that
+ * the OperationContext is interrupted when the CancellationToken is canceled.
*/
class CancelableOperationContext {
public: