1
// Copyright (c) 2012 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.
5
#ifndef BASE_MAC_LIBDISPATCH_SEQUENCED_TASK_RUNNER_H_
6
#define BASE_MAC_LIBDISPATCH_SEQUENCED_TASK_RUNNER_H_
8
#include <dispatch/dispatch.h>
10
#include "base/single_thread_task_runner.h"
11
#include "base/synchronization/waitable_event.h"
16
// This is an implementation of the TaskRunner interface that runs closures on
17
// a thread managed by Apple's libdispatch. This has the benefit of being able
18
// to PostTask() and friends to a dispatch queue, while being reusable as a
21
// One would use this class if an object lives exclusively on one thread but
22
// needs a dispatch_queue_t for use in a system API. This ensures all dispatch
23
// callbacks happen on the same thread as Closure tasks.
25
// A LibDispatchTaskRunner will continue to run until all references to the
26
// underlying dispatch queue are released.
29
// - There is no MessageLoop running on this thread, and ::current() returns
31
// - No nested loops can be run, and all tasks are run non-nested.
32
// - Work scheduled via libdispatch runs at the same priority as and is
33
// interleaved with posted tasks, though FIFO order is guaranteed.
35
class BASE_EXPORT LibDispatchTaskRunner : public base::SingleThreadTaskRunner {
37
// Starts a new serial dispatch queue with a given name.
38
explicit LibDispatchTaskRunner(const char* name);
41
virtual bool PostDelayedTask(const tracked_objects::Location& from_here,
43
base::TimeDelta delay) OVERRIDE;
44
virtual bool RunsTasksOnCurrentThread() const OVERRIDE;
46
// base::SequencedTaskRunner:
47
virtual bool PostNonNestableDelayedTask(
48
const tracked_objects::Location& from_here,
50
base::TimeDelta delay) OVERRIDE;
52
// This blocks the calling thread until all work on the dispatch queue has
53
// been run and the queue has been destroyed. Destroying a queue requires
54
// ALL retained references to it to be released. Any new tasks posted to
55
// this thread after shutdown are dropped.
58
// Returns the dispatch queue associated with this task runner, for use with
59
// system APIs that take dispatch queues. The caller is responsible for
60
// retaining the result.
62
// All properties (context, finalizer, etc.) are managed by this class, and
63
// clients should only use the result of this for dispatch_async().
64
dispatch_queue_t GetDispatchQueue() const;
67
virtual ~LibDispatchTaskRunner();
70
static void Finalizer(void* context);
72
dispatch_queue_t queue_;
74
// The event on which Shutdown waits until Finalizer runs.
75
base::WaitableEvent queue_finalized_;
81
#endif // BASE_MAC_LIBDISPATCH_SEQUENCED_TASK_RUNNER_H_