• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef BASE_TEST_THREAD_TEST_HELPER_H_
6 #define BASE_TEST_THREAD_TEST_HELPER_H_
7 
8 #include "base/compiler_specific.h"
9 #include "base/memory/ref_counted.h"
10 #include "base/message_loop/message_loop_proxy.h"
11 #include "base/synchronization/waitable_event.h"
12 
13 namespace base {
14 
15 // Helper class that executes code on a given thread while blocking on the
16 // invoking thread. To use, derive from this class and overwrite RunTest. An
17 // alternative use of this class is to use it directly.  It will then block
18 // until all pending tasks on a given thread have been executed.
19 class ThreadTestHelper : public RefCountedThreadSafe<ThreadTestHelper> {
20  public:
21   explicit ThreadTestHelper(MessageLoopProxy* target_thread);
22 
23   // True if RunTest() was successfully executed on the target thread.
24   bool Run() WARN_UNUSED_RESULT;
25 
26   virtual void RunTest();
27 
28  protected:
29   friend class RefCountedThreadSafe<ThreadTestHelper>;
30 
31   virtual ~ThreadTestHelper();
32 
33   // Use this method to store the result of RunTest().
set_test_result(bool test_result)34   void set_test_result(bool test_result) { test_result_ = test_result; }
35 
36  private:
37   void RunInThread();
38 
39   bool test_result_;
40   scoped_refptr<MessageLoopProxy> target_thread_;
41   WaitableEvent done_event_;
42 
43   DISALLOW_COPY_AND_ASSIGN(ThreadTestHelper);
44 };
45 
46 }  // namespace base
47 
48 #endif  // BASE_TEST_THREAD_TEST_HELPER_H_
49