File: AsyncMethodRunner.h

package info (click to toggle)
chromium-browser 41.0.2272.118-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 2,189,132 kB
  • sloc: cpp: 9,691,462; ansic: 3,341,451; python: 712,689; asm: 518,779; xml: 208,926; java: 169,820; sh: 119,353; perl: 68,907; makefile: 28,311; yacc: 13,305; objc: 11,385; tcl: 3,186; cs: 2,225; sql: 2,217; lex: 2,215; lisp: 1,349; pascal: 1,256; awk: 407; ruby: 155; sed: 53; php: 14; exp: 11
file content (140 lines) | stat: -rw-r--r-- 4,352 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/*
 * Copyright (C) 2013 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef AsyncMethodRunner_h
#define AsyncMethodRunner_h

#include "platform/Timer.h"
#include "wtf/FastAllocBase.h"
#include "wtf/Noncopyable.h"

namespace blink {

template <typename TargetClass>
class AsyncMethodRunner final {
    WTF_MAKE_NONCOPYABLE(AsyncMethodRunner);
    WTF_MAKE_FAST_ALLOCATED;
public:
    typedef void (TargetClass::*TargetMethod)();

    AsyncMethodRunner(TargetClass* object, TargetMethod method)
        : m_timer(this, &AsyncMethodRunner<TargetClass>::fired)
        , m_object(object)
        , m_method(method)
        , m_suspended(false)
        , m_runWhenResumed(false)
    {
    }

    // Schedules to run the method asynchronously. Do nothing if it's already
    // scheduled. If it's suspended, remember to schedule to run the method when
    // resume() is called.
    void runAsync()
    {
        if (m_suspended) {
            ASSERT(!m_timer.isActive());
            m_runWhenResumed = true;
            return;
        }

        // FIXME: runAsync should take a TraceLocation and pass it to timer here.
        if (!m_timer.isActive())
            m_timer.startOneShot(0, FROM_HERE);
    }

    // If it's scheduled to run the method, cancel it and remember to schedule
    // it again when resume() is called. Mainly for implementing
    // ActiveDOMObject::suspend().
    void suspend()
    {
        if (m_suspended)
            return;
        m_suspended = true;

        if (!m_timer.isActive())
            return;

        m_timer.stop();
        m_runWhenResumed = true;
    }

    // Resumes pending method run.
    void resume()
    {
        if (!m_suspended)
            return;
        m_suspended = false;

        if (!m_runWhenResumed)
            return;

        m_runWhenResumed = false;
        // FIXME: resume should take a TraceLocation and pass it to timer here.
        m_timer.startOneShot(0, FROM_HERE);
    }

    void stop()
    {
        if (m_suspended) {
            ASSERT(!m_timer.isActive());
            m_runWhenResumed = false;
            m_suspended = false;
            return;
        }

        ASSERT(!m_runWhenResumed);
        if (m_timer.isActive())
            m_timer.stop();
    }

    bool isActive() const
    {
        return m_timer.isActive();
    }

private:
    void fired(Timer<AsyncMethodRunner<TargetClass> >*) { (m_object->*m_method)(); }

    Timer<AsyncMethodRunner<TargetClass> > m_timer;

    // FIXME: oilpan: AsyncMethodRunner should be moved to the heap and m_object should be traced.
    // This raw pointer is safe as long as AsyncMethodRunner<X> is held by the X itself
    // (That's the case in the current code base).
    GC_PLUGIN_IGNORE("363031")
    TargetClass* m_object;
    TargetMethod m_method;

    bool m_suspended;
    bool m_runWhenResumed;
};

}

#endif