TaskScheduler: Add SequenceToken and ScopedSetSequenceTokenForCurrentThread

base/sequence_token.h

+// Copyright 2016 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef BASE_SEQUENCE_TOKEN_H_
+#define BASE_SEQUENCE_TOKEN_H_
+
+#include "base/base_export.h"
+#include "base/macros.h"
+
+namespace base {
+
+// A token that identifies a series of sequenced tasks (i.e. tasks that run one
+// at a time in posting order).
+class BASE_EXPORT SequenceToken {
+ public:
+  // Instantiates an invalid SequenceToken.
+  SequenceToken() = default;
+
+  // Explicitly allow copy.
+  SequenceToken(const SequenceToken& other) = default;
+  SequenceToken& operator=(const SequenceToken& other) = default;
+
+  bool operator==(const SequenceToken& other) const;

[danakj, 2016/07/26 19:34:37]

Can you document that an invalid token is not equal to any other token,
including other invalid tokens.

[fdoray, 2016/07/26 20:35:45]

Done.

+  bool operator!=(const SequenceToken& other) const;
+
+  // Returns true if this is a valid SequenceToken.
+  bool IsValid() const;
+
+  // Returns a valid SequenceToken which isn't equal to any previously returned
+  // SequenceToken.
+  static SequenceToken Create();
+
+  // Returns the SequenceToken associated with the task running on the current
+  // thread, as determined by the active ScopedSetCurrentSequenceToken if any.
+  static SequenceToken GetCurrent();

[danakj, 2016/07/26 19:34:37]

nit: I'ld like GetForCurrentThread() a bit better to point out this is using
TLS.

[fdoray, 2016/07/26 20:35:45]

Done.

+
+ private:
+  SequenceToken(int token) : token_(token) {}
+
+  static constexpr int kInvalidSequenceToken = -1;
+  int token_ = kInvalidSequenceToken;
+};
+
+// Throughout its lifetime, determines the value returned by
+// SequenceToken::GetCurrent().
+class BASE_EXPORT ScopedSetCurrentSequenceToken {

[danakj, 2016/07/26 19:34:37]

and ScopedSetSequenceTokenForCurrentThread?

[fdoray, 2016/07/26 20:35:45]

Done.

+ public:
+  ScopedSetCurrentSequenceToken(const SequenceToken& token);
+  ~ScopedSetCurrentSequenceToken();
+
+ private:
+  friend class SequenceToken;
+
+  const SequenceToken token_;
+
+  DISALLOW_COPY_AND_ASSIGN(ScopedSetCurrentSequenceToken);
+};
+
+}  // namespace base
+
+#endif  // BASE_SEQUENCE_TOKEN_H_