-
Notifications
You must be signed in to change notification settings - Fork 496
Expand file tree
/
Copy pathDispatchPolicy.h
More file actions
66 lines (55 loc) · 2.28 KB
/
DispatchPolicy.h
File metadata and controls
66 lines (55 loc) · 2.28 KB
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
// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
#ifndef FRAMEWORK_DISPATCHPOLICY_H
#define FRAMEWORK_DISPATCHPOLICY_H
#include <functional>
#include <string>
#include <vector>
namespace o2
{
namespace framework
{
struct DeviceSpec;
struct Output;
/// Policy to describe when to dispatch objects
/// As for now we describe this policy per device, however it can be extended
/// to match on specific outputs of the device.
struct DispatchPolicy {
/// Action to take whenever an object in the output gets ready:
///
enum struct DispatchOp {
/// Dispatch objects when the calculation ends, this means the devices will
/// send messages from all contextes in one bulk after computation
AfterComputation,
/// Dispatch the object when it becomes ready, i.e. when it goes out of the
/// scope of the user code and no changes to the object are possible
WhenReady,
};
using DeviceMatcher = std::function<bool(DeviceSpec const& device)>;
// OutputMatcher can be a later extension, but not expected to be of high priority
using TriggerMatcher = std::function<bool(Output const&)>;
/// Name of the policy itself.
std::string name;
/// Callback to be used to understand if the policy should apply
/// to the given device.
DeviceMatcher deviceMatcher;
/// the action to be used for matched devices
DispatchOp action = DispatchOp::AfterComputation;
/// matcher on specific output to trigger sending
TriggerMatcher triggerMatcher = defaultDispatchPolicy();
static TriggerMatcher defaultDispatchPolicy();
/// Helper to create the default configuration.
static std::vector<DispatchPolicy> createDefaultPolicies();
};
std::ostream& operator<<(std::ostream& oss, DispatchPolicy::DispatchOp const& val);
} // namespace framework
} // namespace o2
#endif // FRAMEWORK_DISPATCHPOLICY_H