HDK
 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 PXR_BASE_WORK_DETACHED_TASK_H
25 #define PXR_BASE_WORK_DETACHED_TASK_H
26 
27 /// \file work/detachedTask.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/base/tf/errorMark.h"
31 #include "pxr/base/work/api.h"
33 
34 #include <type_traits>
35 #include <utility>
36 
38 
39 template <class Fn>
41 {
42  explicit Work_DetachedTask(Fn &&fn) : _fn(std::move(fn)) {}
43  explicit Work_DetachedTask(Fn const &fn) : _fn(fn) {}
44  void operator()() {
45  TfErrorMark m;
46  _fn();
47  m.Clear();
48  }
49 private:
50  Fn _fn;
51 };
52 
55 
58 
59 /// Invoke \p fn asynchronously, discard any errors it produces, and provide
60 /// no way to wait for it to complete.
61 template <class Fn>
62 void WorkRunDetachedTask(Fn &&fn)
63 {
64  using FnType = typename std::remove_reference<Fn>::type;
65  Work_DetachedTask<FnType> task(std::forward<Fn>(fn));
66  if (WorkHasConcurrency()) {
67  Work_GetDetachedDispatcher().Run(std::move(task));
69  }
70  else {
71  task();
72  }
73 }
74 
76 
77 #endif // PXR_BASE_WORK_DETACHED_TASK_H
type
Definition: core.h:977
WORK_API void Work_EnsureDetachedTaskProgress()
Work_DetachedTask(Fn const &fn)
Definition: detachedTask.h:43
WORK_API WorkDispatcher & Work_GetDetachedDispatcher()
#define WORK_API
Definition: api.h:40
void WorkRunDetachedTask(Fn &&fn)
Definition: detachedTask.h:62
void Run(Callable &&c)
Definition: dispatcher.h:101
bool Clear() const
Definition: errorMark.h:109
Work_DetachedTask(Fn &&fn)
Definition: detachedTask.h:42
WORK_API bool WorkHasConcurrency()
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
const GLdouble * m
Definition: glew.h:9166