OLD | NEW |
| (Empty) |
1 /* | |
2 * Copyright (C) 2009-2010 Google Inc. All rights reserved. | |
3 * | |
4 * Redistribution and use in source and binary forms, with or without | |
5 * modification, are permitted provided that the following conditions are | |
6 * met: | |
7 * | |
8 * * Redistributions of source code must retain the above copyright | |
9 * notice, this list of conditions and the following disclaimer. | |
10 * * Redistributions in binary form must reproduce the above | |
11 * copyright notice, this list of conditions and the following disclaimer | |
12 * in the documentation and/or other materials provided with the | |
13 * distribution. | |
14 * * Neither the name of Google Inc. nor the names of its | |
15 * contributors may be used to endorse or promote products derived from | |
16 * this software without specific prior written permission. | |
17 * | |
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
29 */ | |
30 | |
31 #ifndef CrossThreadTask_h | |
32 #define CrossThreadTask_h | |
33 | |
34 #include "core/dom/ExecutionContext.h" | |
35 #include "core/dom/ExecutionContextTask.h" | |
36 #include "platform/CrossThreadFunctional.h" | |
37 #include <type_traits> | |
38 | |
39 namespace blink { | |
40 | |
41 // createCrossThreadTask(...) is ExecutionContextTask version of | |
42 // crossThreadBind(). | |
43 // Using WTF::bind() directly is not thread-safe due to temporary objects, see | |
44 // https://crbug.com/390851 for details. | |
45 // | |
46 // Example: | |
47 // void func1(int, const String&); | |
48 // createCrossThreadTask(func1, 42, str); | |
49 // func1(42, str2) will be called, where |str2| is a deep copy of | |
50 // |str| (created by str.isolatedCopy()). | |
51 // | |
52 // Don't (if you pass the task across threads): | |
53 // bind(func1, 42, str); | |
54 // bind(func1, 42, str.isolatedCopy()); | |
55 // | |
56 // For functions: | |
57 // void functionEC(MP1, ..., MPn, ExecutionContext*); | |
58 // void function(MP1, ..., MPn); | |
59 // class C { | |
60 // void memberEC(MP1, ..., MPn, ExecutionContext*); | |
61 // void member(MP1, ..., MPn); | |
62 // }; | |
63 // We create tasks represented by std::unique_ptr<ExecutionContextTask>: | |
64 // createCrossThreadTask(functionEC, const P1& p1, ..., const Pn& pn); | |
65 // createCrossThreadTask(memberEC, C* ptr, const P1& p1, ..., const Pn& pn); | |
66 // createCrossThreadTask(function, const P1& p1, ..., const Pn& pn); | |
67 // createCrossThreadTask(member, C* ptr, const P1& p1, ..., const Pn& pn); | |
68 // (|ptr| can also be WeakPtr<C> or other pointer-like types) | |
69 // and then the following are called on the target thread: | |
70 // functionEC(p1, ..., pn, context); | |
71 // ptr->memberEC(p1, ..., pn, context); | |
72 // function(p1, ..., pn); | |
73 // ptr->member(p1, ..., pn); | |
74 // | |
75 // ExecutionContext: | |
76 // |context| is supplied by the target thread. | |
77 // | |
78 // Deep copies by crossThreadBind(): | |
79 // |ptr|, |p1|, ..., |pn| are processed by crossThreadBind() and thus | |
80 // CrossThreadCopier. | |
81 // You don't have to call manually e.g. isolatedCopy(). | |
82 // To pass things that cannot be copied by CrossThreadCopier | |
83 // (e.g. pointers), use crossThreadUnretained() explicitly. | |
84 | |
85 template<typename FunctionType, typename... P> | |
86 std::unique_ptr<ExecutionContextTask> createCrossThreadTask(FunctionType functio
n, P&&... parameters) | |
87 { | |
88 return internal::createCallClosureTask(crossThreadBind(function, std::forwar
d<P>(parameters)...)); | |
89 } | |
90 | |
91 } // namespace blink | |
92 | |
93 #endif // CrossThreadTask_h | |
OLD | NEW |