helics  2.8.1
Public Member Functions | Public Attributes | List of all members
helics::BasicBrokerInfo Class Reference

#include <CoreBroker.hpp>

Public Member Functions

 BasicBrokerInfo (const std::string &brokerName)
 

Public Attributes

const std::string name
 the name of the broker
 
global_broker_id global_id
 the global identifier for the broker
 
route_id route
 the identifier for the route to take to the broker
 
global_broker_id parent
 the id of the parent broker/core
 
connection_state state
 specify the current status of the broker More...
 
bool _hasTimeDependency
 flag indicating that a broker has general endpoints it is coordinating More...
 
bool _core {false}
 if set to true the broker is a core false is a broker;
 
bool _nonLocal {false}
 indicator that the broker has a subbroker as a parent.
 
bool _route_key {false}
 indicator that the broker has a unique route id
 
bool _sent_disconnect_ack {false}
 indicator that the disconnect ack has been sent
 
bool _disable_ping {false}
 indicator that the broker doesn't respond to pings
 
std::string routeInfo
 string describing the connection information for the route
 

Detailed Description

class defining the common information about a broker federate

Member Data Documentation

◆ _hasTimeDependency

bool helics::BasicBrokerInfo::_hasTimeDependency
Initial value:
{
false}

flag indicating that a broker has general endpoints it is coordinating

◆ state

connection_state helics::BasicBrokerInfo::state
Initial value:
{
connection_state::connected}

specify the current status of the broker


The documentation for this class was generated from the following file: