All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
detachedTask.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef WORK_DETACHEDTASK_H
25 #define WORK_DETACHEDTASK_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/base/tf/errorMark.h"
31 #include "pxr/base/work/api.h"
32 
33 #include <tbb/task.h>
34 
35 #include <type_traits>
36 #include <utility>
37 
38 PXR_NAMESPACE_OPEN_SCOPE
39 
40 template <class Fn>
41 struct Work_DetachedInvoker : public tbb::task {
42  explicit Work_DetachedInvoker(Fn &&fn) : _fn(std::move(fn)) {}
43  explicit Work_DetachedInvoker(Fn const &fn) : _fn(fn) {}
44  virtual tbb::task *execute() {
45  TfErrorMark m;
46  _fn();
47  m.Clear();
48  return nullptr;
49  }
50 private:
51  Fn _fn;
52 };
53 
54 WORK_API tbb::task_group_context &Work_GetDetachedTaskGroupContext();
55 
58 template <class Fn>
59 void WorkRunDetachedTask(Fn &&fn)
60 {
61  using FnType = typename std::remove_reference<Fn>::type;
62  tbb::task::enqueue(
63  *new (tbb::task::allocate_root(Work_GetDetachedTaskGroupContext()))
64  Work_DetachedInvoker<FnType>(std::forward<Fn>(fn)));
65 }
66 
67 PXR_NAMESPACE_CLOSE_SCOPE
68 
69 #endif // WORK_DETACHEDTASK_H
bool Clear() const
Remove all errors in this mark from the error system.
Definition: errorMark.h:109
void WorkRunDetachedTask(Fn &&fn)
Invoke fn asynchronously, discard any errors it produces, and provide no way to wait for it to comple...
Definition: detachedTask.h:59
Class used to record the end of the error-list.
Definition: errorMark.h:66