Skip to content

Commit 915ecf3

Browse files
chrisbeard678098
andauthored
Docs[mqbnet]: Doxygen updates for ClusterActiveNodeManager (#962)
Signed-off-by: Christopher Beard <[email protected]> Signed-off-by: Chris Beard <[email protected]> Co-authored-by: Evgenii Malygin <[email protected]>
1 parent c933b70 commit 915ecf3

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

src/groups/mqb/mqbnet/mqbnet_clusteractivenodemanager.h

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ namespace mqbnet {
219219
/// Mechanism to manage an active node from an associated cluster.
220220
class ClusterActiveNodeManager {
221221
public:
222-
// public TYPES
222+
// PUBLIC TYPES
223223

224224
enum eResult {
225225
e_NO_CHANGE = 0,
@@ -236,38 +236,35 @@ class ClusterActiveNodeManager {
236236
struct NodeContext {
237237
bmqp_ctrlmsg::NodeStatus::Value d_status;
238238

239+
/// Current session description
239240
bsl::string d_sessionDescription;
240-
// Current session description
241241
};
242242

243243
typedef bsl::map<mqbnet::ClusterNode*, NodeContext> NodesMap;
244244

245245
private:
246246
// DATA
247+
248+
/// A description string, used while printing logs.
247249
bsl::string d_description;
248-
// A description string, used while
249-
// printing logs.
250250

251+
/// The dataCenter the current machine resides in.
251252
bsl::string d_dataCenter;
252-
// The dataCenter the current machine
253-
// resides in.
254253

254+
/// Cached nodes status and sessions.
255255
NodesMap d_nodes;
256-
// Cached nodes status and sessions.
257256

257+
/// Pointer to the currently active node and its context.
258258
NodesMap::const_iterator d_activeNodeIt;
259-
// Pointer to the currently active node
260-
// and its context.
261259

262260
/// If true, remove the data center requirement when selecting active
263261
/// node. Set to true when the cluster does not have any nodes in the
264262
/// current machine's data center.
265263
bool d_ignoreDataCenter;
266264

265+
/// If true, drop the same data center requirement when selecting active
266+
/// node.
267267
bool d_useExtendedSelection;
268-
// If true, drop the same data center
269-
// requirement when selecting active
270-
// node.
271268

272269
private:
273270
// PRIVATE MANIPULATORS

0 commit comments

Comments
 (0)