test_io_thread.h revision 1320f92c476a1ad9d19dba2a48c72b75566198e9
11320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// Copyright 2013 The Chromium Authors. All rights reserved.
21320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// Use of this source code is governed by a BSD-style license that can be
31320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// found in the LICENSE file.
41320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
51320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#ifndef BASE_TEST_TEST_IO_THREAD_H_
61320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#define BASE_TEST_TEST_IO_THREAD_H_
71320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
81320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "base/callback_forward.h"
91320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "base/compiler_specific.h"
101320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "base/macros.h"
111320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "base/memory/ref_counted.h"
121320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "base/task_runner.h"
131320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "base/threading/thread.h"
141320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "base/time/time.h"
151320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
161320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tuccinamespace base {
171320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
181320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// Create and run an IO thread with a MessageLoop, and
191320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// making the MessageLoop accessible from its client.
201320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// It also provides some ideomatic API like PostTaskAndWait().
211320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucciclass TestIOThread {
221320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci public:
231320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  enum Mode { kAutoStart, kManualStart };
241320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  explicit TestIOThread(Mode mode);
251320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  // Stops the I/O thread if necessary.
261320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  ~TestIOThread();
271320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
281320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  // |Start()|/|Stop()| should only be called from the main (creation) thread.
291320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  // After |Stop()|, |Start()| may be called again to start a new I/O thread.
301320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  // |Stop()| may be called even when the I/O thread is not started.
311320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  void Start();
321320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  void Stop();
331320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
341320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  // Post |task| to the IO thread.
351320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  void PostTask(const tracked_objects::Location& from_here,
361320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci                const base::Closure& task);
371320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  // Posts |task| to the IO-thread with an WaitableEvent associated blocks on
381320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  // it until the posted |task| is executed, then returns.
391320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  void PostTaskAndWait(const tracked_objects::Location& from_here,
401320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci                       const base::Closure& task);
411320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
421320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  base::MessageLoopForIO* message_loop() {
431320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci    return static_cast<base::MessageLoopForIO*>(io_thread_.message_loop());
441320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  }
451320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
461320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  scoped_refptr<SingleThreadTaskRunner> task_runner() {
471320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci    return message_loop()->task_runner();
481320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  }
491320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
501320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci private:
511320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  base::Thread io_thread_;
521320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  bool io_thread_started_;
531320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
541320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  DISALLOW_COPY_AND_ASSIGN(TestIOThread);
551320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci};
561320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
571320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci}  // namespace base
581320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
591320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#endif  // BASE_TEST_TEST_IO_THREAD_H_
60