Loading...
Searching...
No Matches
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
28
29#include "pxr/pxr.h"
31#include "pxr/base/work/api.h"
33
34#include <type_traits>
35#include <utility>
36
37PXR_NAMESPACE_OPEN_SCOPE
38
39template <class Fn>
40struct Work_DetachedTask
41{
42 explicit Work_DetachedTask(Fn &&fn) : _fn(std::move(fn)) {}
43 explicit Work_DetachedTask(Fn const &fn) : _fn(fn) {}
44 void operator()() {
46 _fn();
47 m.Clear();
48 }
49private:
50 Fn _fn;
51};
52
53WORK_API
54WorkDispatcher &Work_GetDetachedDispatcher();
55
56WORK_API
57void Work_EnsureDetachedTaskProgress();
58
61template <class 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));
68 Work_EnsureDetachedTaskProgress();
69 }
70 else {
71 task();
72 }
73}
74
75PXR_NAMESPACE_CLOSE_SCOPE
76
77#endif // PXR_BASE_WORK_DETACHED_TASK_H
Class used to record the end of the error-list.
Definition: errorMark.h:65
bool Clear() const
Remove all errors in this mark from the error system.
Definition: errorMark.h:109
A work dispatcher runs concurrent tasks.
Definition: dispatcher.h:76
void Run(Callable &&c, A1 &&a1, A2 &&a2,... AN &&aN)
Add work for the dispatcher to run.
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:62
STL namespace.
WORK_API bool WorkHasConcurrency()
Return true if WorkGetPhysicalConcurrencyLimit() returns a number greater than 1 and PXR_WORK_THREAD_...