blob: 11857cf4ba4a9883468993ece54a8c3d96e43122 (
plain) (
blame)
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
#include <vespa/messagebus/common.h>
#include <vector>
namespace mbus {
/**
* Along with the {@link RoutingSpec}, {@link RoutingTableSpec} and {@link RouteSpec}, this holds the routing
* specifications for all protocols. The only way a client can configure or alter the settings of a message bus instance
* is through these classes.
*
* This class contains the spec for a single hop.
*
* @author Simon Thoresen Hult
* @version $Id$
*/
class HopSpec {
private:
string _name;
string _selector;
std::vector<string> _recipients;
bool _ignoreResult;
public:
/**
* The default constructor requires both the name and the selector.
*
* @param name A protocol unique name for this hop.
* @param selector A string that represents the selector for this hop.
*/
HopSpec(const string &name, const string &selector);
HopSpec(const HopSpec & rhs);
HopSpec & operator=(const HopSpec & rhs);
HopSpec(HopSpec && rhs) noexcept;
HopSpec & operator=(HopSpec && rhs) noexcept;
~HopSpec();
/**
* Returns the protocol-unique name of this hop.
*
* @return The name.
*/
[[nodiscard]] const string &getName() const { return _name; }
/**
* Returns the string selector that resolves the recipients of this hop.
*
* @return The selector.
*/
[[nodiscard]] const string &getSelector() const { return _selector; }
/**
* Returns the number of recipients that the selector can choose from.
*
* @return The number of recipients.
*/
[[nodiscard]] uint32_t getNumRecipients() const { return _recipients.size(); }
/**
* Returns the recipients at the given index.
*
* @param i The index of the recipient to return.
* @return The recipient at the given index.
*/
[[nodiscard]] const string &getRecipient(uint32_t i) const { return _recipients[i]; }
/**
* Adds the given recipient to this.
*
* @param recipient The recipient to add.
* @return This, to allow chaining.
*/
HopSpec & addRecipient(const string &recipient) &;
HopSpec && addRecipient(const string &recipient) &&;
/**
* Returns whether or not to ignore the result when routing through this hop.
*
* @return True to ignore the result.
*/
[[nodiscard]] bool getIgnoreResult() const { return _ignoreResult; }
/**
* Sets whether or not to ignore the result when routing through this hop.
*
* @param ignoreResult Whether or not to ignore the result.
* @return This, to allow chaining.
*/
HopSpec &setIgnoreResult(bool ignoreResult) {
_ignoreResult = ignoreResult;
return *this;
}
/**
* Appends the content of this to the given config string.
*
* @param cfg The config to add to.
* @param prefix The prefix to use for each add.
*/
void toConfig(string &cfg, const string &prefix) const;
/**
* Returns a string representation of this.
*
* @return The string.
*/
[[nodiscard]] string toString() const;
/**
* Implements the equality operator.
*
* @param rhs The object to compare to.
* @return True if this equals the other.
*/
bool operator==(const HopSpec &rhs) const;
/**
* Implements the inequality operator.
*
* @param rhs The object to compare to.
* @return True if this does not equals the other.
*/
bool operator!=(const HopSpec &rhs) const { return !(*this == rhs); }
};
} // namespace mbus
|
