cancellation_flag.h 1.18 KB
Newer Older
gejun's avatar
gejun committed
1 2 3 4
// Copyright (c) 2011 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.

5 6
#ifndef BUTIL_SYNCHRONIZATION_CANCELLATION_FLAG_H_
#define BUTIL_SYNCHRONIZATION_CANCELLATION_FLAG_H_
gejun's avatar
gejun committed
7

8 9 10
#include "butil/base_export.h"
#include "butil/atomicops.h"
#include "butil/threading/platform_thread.h"
gejun's avatar
gejun committed
11

12
namespace butil {
gejun's avatar
gejun committed
13 14 15 16 17 18

// CancellationFlag allows one thread to cancel jobs executed on some worker
// thread. Calling Set() from one thread and IsSet() from a number of threads
// is thread-safe.
//
// This class IS NOT intended for synchronization between threads.
19
class BUTIL_EXPORT CancellationFlag {
gejun's avatar
gejun committed
20 21 22 23 24 25 26 27 28 29 30 31 32
 public:
  CancellationFlag() : flag_(false) {
#if !defined(NDEBUG)
    set_on_ = PlatformThread::CurrentId();
#endif
  }
  ~CancellationFlag() {}

  // Set the flag. May only be called on the thread which owns the object.
  void Set();
  bool IsSet() const;  // Returns true iff the flag was set.

 private:
33
  butil::subtle::Atomic32 flag_;
gejun's avatar
gejun committed
34 35 36 37 38 39 40
#if !defined(NDEBUG)
  PlatformThreadId set_on_;
#endif

  DISALLOW_COPY_AND_ASSIGN(CancellationFlag);
};

41
}  // namespace butil
gejun's avatar
gejun committed
42

43
#endif  // BUTIL_SYNCHRONIZATION_CANCELLATION_FLAG_H_