src/third_party/WebKit/Source/platform/TaskSynchronizer.h

   1 /*
   2  * Copyright (C) 2007, 2008, 2013 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef TaskSynchronizer_h
  30 #define TaskSynchronizer_h
  31
  32 #include "platform/PlatformExport.h"
  33 #include "wtf/Noncopyable.h"
  34 #include "wtf/Threading.h"
  35 #include "wtf/ThreadingPrimitives.h"
  36
  37 namespace blink {
  38
  39 // TaskSynchronizer can be used to wait for task completion.
  40 class PLATFORM_EXPORT TaskSynchronizer {
  41     WTF_MAKE_NONCOPYABLE(TaskSynchronizer);
  42 public:
  43     TaskSynchronizer();
  44
  45     // Called from a thread that waits for the task completion.
  46     void waitForTaskCompletion();
  47
  48     // Called from a thread that executes the task.
  49     void taskCompleted();
  50
  51 #if ENABLE(ASSERT)
  52     bool hasCheckedForTermination() const { return m_hasCheckedForTermination; }
  53     void setHasCheckedForTermination() { m_hasCheckedForTermination = true; }
  54 #endif
  55
  56 private:
  57     void waitForTaskCompletionInternal();
  58
  59     bool m_taskCompleted;
  60     Mutex m_synchronousMutex;
  61     ThreadCondition m_synchronousCondition;
  62 #if ENABLE(ASSERT)
  63     bool m_hasCheckedForTermination;
  64 #endif
  65 };
  66
  67 } // namespace blink
  68
  69 #endif // TaskSynchronizer_h