15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved.
25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file.
45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/common/worker_thread_ticker.h"
65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <algorithm>
85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/bind.h"
105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/bind_helpers.h"
115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h"
129ab5563a3196760eb381d102cbb2bc0f7abc6a50Ben Murdoch#include "base/message_loop/message_loop.h"
135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/threading/thread.h"
145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)WorkerThreadTicker::WorkerThreadTicker(int tick_interval)
165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    : timer_thread_("worker_thread_ticker"),
175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      is_running_(false),
185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      tick_interval_(base::TimeDelta::FromMilliseconds(tick_interval)) {
195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)WorkerThreadTicker::~WorkerThreadTicker() {
225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Stop();
235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool WorkerThreadTicker::RegisterTickHandler(Callback *tick_handler) {
265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DCHECK(tick_handler);
275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  base::AutoLock lock(lock_);
285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // You cannot change the list of handlers when the timer is running.
295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // You need to call Stop first.
305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (IsRunning())
315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return false;
325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  tick_handler_list_.push_back(tick_handler);
335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return true;
345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool WorkerThreadTicker::UnregisterTickHandler(Callback *tick_handler) {
375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DCHECK(tick_handler);
385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  base::AutoLock lock(lock_);
395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // You cannot change the list of handlers when the timer is running.
405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // You need to call Stop first.
415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (IsRunning()) {
425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return false;
435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  TickHandlerListType::iterator index = std::remove(tick_handler_list_.begin(),
455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                                    tick_handler_list_.end(),
465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                                    tick_handler);
475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (index == tick_handler_list_.end()) {
485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return false;
495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  tick_handler_list_.erase(index, tick_handler_list_.end());
515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return true;
525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool WorkerThreadTicker::Start() {
555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Do this in a lock because we don't want 2 threads to
565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // call Start at the same time
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  base::AutoLock lock(lock_);
585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (IsRunning())
595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return false;
605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (!timer_thread_.Start())
615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return false;
625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  is_running_ = true;
635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  ScheduleTimerTask();
645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return true;
655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool WorkerThreadTicker::Stop() {
685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Do this in a lock because we don't want 2 threads to
695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // call Stop at the same time
705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  base::AutoLock lock(lock_);
715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (!IsRunning())
725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return false;
735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  is_running_ = false;
745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  timer_thread_.Stop();
755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return true;
765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void WorkerThreadTicker::ScheduleTimerTask() {
795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  timer_thread_.message_loop()->PostDelayedTask(
805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      FROM_HERE,
815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      base::Bind(&WorkerThreadTicker::TimerTask, base::Unretained(this)),
825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      tick_interval_);
835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void WorkerThreadTicker::TimerTask() {
865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // When the ticker is running, the handler list CANNOT be modified.
875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // So we can do the enumeration safely without a lock
885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const TickHandlerListType& handlers = tick_handler_list_;
895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  for (TickHandlerListType::const_iterator i = handlers.begin();
905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)       i != handlers.end(); ++i) {
915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    (*i)->OnTick();
925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  ScheduleTimerTask();
955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
97