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
|
/*
* Copyright (C) 2021 Apple 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:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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.
*/
#pragma once
#include <wtf/CompletionHandler.h>
#include <wtf/Condition.h>
#include <wtf/Deque.h>
#include <wtf/Lock.h>
#include <wtf/WorkQueue.h>
namespace WTF {
class WTF_EXPORT_PRIVATE SuspendableWorkQueue final : public WorkQueue {
public:
using QOS = WorkQueue::QOS;
enum class ShouldLog : bool { No, Yes };
static Ref<SuspendableWorkQueue> create(ASCIILiteral name, QOS = QOS::Default, ShouldLog = ShouldLog::No);
void suspend(Function<void()>&& suspendFunction, CompletionHandler<void()>&& suspensionCompletionHandler);
void resume();
void dispatch(Function<void()>&&) final;
void dispatchAfter(Seconds, Function<void()>&&) final;
void dispatchSync(Function<void()>&&) final;
private:
SuspendableWorkQueue(ASCIILiteral name, QOS, ShouldLog);
void invokeAllSuspensionCompletionHandlers() WTF_REQUIRES_LOCK(m_suspensionLock);
void suspendIfNeeded();
#if USE(COCOA_EVENT_LOOP)
using WorkQueue::dispatchQueue;
#else
using WorkQueue::runLoop;
#endif
enum class State : uint8_t { Running, WillSuspend, Suspended };
static ASCIILiteral stateString(State);
Lock m_suspensionLock;
Condition m_suspensionCondition;
State m_state WTF_GUARDED_BY_LOCK(m_suspensionLock) { State::Running };
Function<void()> m_suspendFunction WTF_GUARDED_BY_LOCK(m_suspensionLock);
Vector<CompletionHandler<void()>> m_suspensionCompletionHandlers WTF_GUARDED_BY_LOCK(m_suspensionLock);
bool m_shouldLog WTF_GUARDED_BY_LOCK(m_suspensionLock) { false };
};
} // namespace WTF
using WTF::SuspendableWorkQueue;
|
