5. API Reference

• 5.1. Exception
  • 5.1.1. BadParameter
    • BadParameter
      • BadParameter::BadParameter()
      • BadParameter::operator=()
      • BadParameter::Exception()
      • BadParameter::Exception()
      • BadParameter::Exception()
  • 5.1.2. CorruptedFile
    • CorruptedFile
      • CorruptedFile::CorruptedFile()
      • CorruptedFile::operator=()
      • CorruptedFile::Exception()
      • CorruptedFile::Exception()
      • CorruptedFile::Exception()
  • 5.1.3. Error
    • Error
      • Error::Error()
      • Error::operator=()
      • Error::Exception()
      • Error::Exception()
      • Error::Exception()
  • 5.1.4. Exception
    • Exception
      • Exception::Exception()
      • Exception::Exception()
      • Exception::Exception()
      • Exception::operator=()
      • Exception::what()
  • 5.1.5. Inconsistency
    • Inconsistency
      • Inconsistency::Inconsistency()
      • Inconsistency::operator=()
      • Inconsistency::Exception()
      • Inconsistency::Exception()
      • Inconsistency::Exception()
  • 5.1.6. PreconditionNotMet
    • PreconditionNotMet
      • PreconditionNotMet::PreconditionNotMet()
      • PreconditionNotMet::operator=()
      • PreconditionNotMet::Exception()
      • PreconditionNotMet::Exception()
      • PreconditionNotMet::Exception()
  • 5.1.7. Unsupported
    • Unsupported
      • Unsupported::Unsupported()
      • Unsupported::operator=()
      • Unsupported::Exception()
      • Unsupported::Exception()
      • Unsupported::Exception()
• 5.2. Listener
  • 5.2.1. CallbackKind
    • CallbackKind
      • CallbackKind::ON_TOPIC_DISCOVERY
      • CallbackKind::ON_PARTICIPANT_DISCOVERY
      • CallbackKind::ON_DATAWRITER_DISCOVERY
      • CallbackKind::ON_DATAREADER_DISCOVERY
      • CallbackKind::ON_HOST_DISCOVERY
      • CallbackKind::ON_USER_DISCOVERY
      • CallbackKind::ON_PROCESS_DISCOVERY
      • CallbackKind::ON_LOCATOR_DISCOVERY
      • CallbackKind::ON_DATA_AVAILABLE
      • CallbackKind::ON_DOMAIN_VIEW_GRAPH_UPDATE
      • CallbackKind::ON_STATUS_REPORTED
      • CallbackKind::ON_ALERT_TRIGGERED
      • CallbackKind::ON_ALERT_TIMEOUT
  • 5.2.2. CallbackMask
    • CallbackMask
  • 5.2.3. DomainListener
    • DomainListener
      • DomainListener::~DomainListener()
      • DomainListener::on_topic_discovery()
      • DomainListener::on_participant_discovery()
      • DomainListener::on_datareader_discovery()
      • DomainListener::on_datawriter_discovery()
      • DomainListener::on_data_available()
      • DomainListener::on_domain_view_graph_update()
      • DomainListener::on_status_reported()
      • DomainListener::on_alert_triggered()
      • DomainListener::on_alert_timeout()
      • DomainListener::Status
        • DomainListener::Status::total_count
        • DomainListener::Status::total_count_change
        • DomainListener::Status::current_count
        • DomainListener::Status::current_count_change
  • 5.2.4. PhysicalListener
    • PhysicalListener
      • PhysicalListener::~PhysicalListener()
      • PhysicalListener::on_host_discovery()
      • PhysicalListener::on_user_discovery()
      • PhysicalListener::on_process_discovery()
      • PhysicalListener::on_locator_discovery()
• 5.3. StatisticsBackend
  • StatisticsBackend
    • StatisticsBackend::StatisticsBackend()
    • StatisticsBackend::set_physical_listener()
    • StatisticsBackend::init_monitor()
    • StatisticsBackend::init_monitor()
    • StatisticsBackend::init_monitor_with_profile()
    • StatisticsBackend::restart_monitor()
    • StatisticsBackend::stop_monitor()
    • StatisticsBackend::clear_monitor()
    • StatisticsBackend::start_topic_spy()
    • StatisticsBackend::stop_topic_spy()
    • StatisticsBackend::set_domain_listener()
    • StatisticsBackend::get_entities()
    • StatisticsBackend::get_alerts()
    • StatisticsBackend::get_entity_by_guid()
    • StatisticsBackend::is_active()
    • StatisticsBackend::is_metatraffic()
    • StatisticsBackend::is_proxy()
    • StatisticsBackend::get_type()
    • StatisticsBackend::get_status()
    • StatisticsBackend::get_info()
    • StatisticsBackend::get_info()
    • StatisticsBackend::get_type_idl()
    • StatisticsBackend::get_ros2_type_name()
    • StatisticsBackend::get_ros2_type_idl()
    • StatisticsBackend::get_endpoint_topic_id()
    • StatisticsBackend::get_domain_id()
    • StatisticsBackend::get_data()
    • StatisticsBackend::get_data()
    • StatisticsBackend::get_data()
    • StatisticsBackend::get_data()
    • StatisticsBackend::get_status_data()
    • StatisticsBackend::get_domain_view_graph()
    • StatisticsBackend::regenerate_domain_graph()
    • StatisticsBackend::dump_database()
    • StatisticsBackend::dump_database()
    • StatisticsBackend::load_database()
    • StatisticsBackend::clear_statistics_data()
    • StatisticsBackend::clear_inactive_entities()
    • StatisticsBackend::reset()
    • StatisticsBackend::get_data_supported_entity_kinds()
    • StatisticsBackend::set_alias()
    • StatisticsBackend::set_alert()
    • StatisticsBackend::remove_alert()
    • StatisticsBackend::set_alerts_polling_time()
    • StatisticsBackend::deserialize_guid()
    • StatisticsBackend::serialize_guid()
    • StatisticsBackend::load_xml_profiles_file()
• 5.4. Types
  • 5.4.1. Bitmask
    • Bitmask
  • 5.4.2. DataKind
    • DataKind
      • DataKind::INVALID
      • DataKind::FASTDDS_LATENCY
      • DataKind::NETWORK_LATENCY
      • DataKind::PUBLICATION_THROUGHPUT
      • DataKind::SUBSCRIPTION_THROUGHPUT
      • DataKind::RTPS_PACKETS_SENT
      • DataKind::RTPS_BYTES_SENT
      • DataKind::RTPS_PACKETS_LOST
      • DataKind::RTPS_BYTES_LOST
      • DataKind::RESENT_DATA
      • DataKind::HEARTBEAT_COUNT
      • DataKind::ACKNACK_COUNT
      • DataKind::NACKFRAG_COUNT
      • DataKind::GAP_COUNT
      • DataKind::DATA_COUNT
      • DataKind::PDP_PACKETS
      • DataKind::EDP_PACKETS
      • DataKind::DISCOVERY_TIME
      • DataKind::SAMPLE_DATAS
  • 5.4.3. DataKindMask
    • DataKindMask
  • 5.4.4. StatusKind
    • StatusKind
      • StatusKind::INVALID
      • StatusKind::PROXY
      • StatusKind::CONNECTION_LIST
      • StatusKind::INCOMPATIBLE_QOS
      • StatusKind::INCONSISTENT_TOPIC
      • StatusKind::LIVELINESS_LOST
      • StatusKind::LIVELINESS_CHANGED
      • StatusKind::DEADLINE_MISSED
      • StatusKind::SAMPLE_LOST
      • StatusKind::EXTENDED_INCOMPATIBLE_QOS
      • StatusKind::STATUSES_SIZE
  • 5.4.5. DomainId
    • DomainId
  • 5.4.6. EntityId
    • EntityId
      • EntityId::EntityId()
      • EntityId::EntityId()
      • EntityId::EntityId()
      • EntityId::EntityId()
      • EntityId::operator=()
      • EntityId::operator=()
      • EntityId::invalidate()
      • EntityId::is_valid()
      • EntityId::is_all()
      • EntityId::is_valid_and_unique()
      • EntityId::value()
      • EntityId::all()
      • EntityId::invalid()
    • operator<<()
    • operator<()
    • operator<=()
    • operator>()
    • operator>=()
    • operator==()
    • operator!=()
  • 5.4.7. EntityKind
    • EntityKind
      • EntityKind::INVALID
      • EntityKind::HOST
      • EntityKind::USER
      • EntityKind::PROCESS
      • EntityKind::DOMAIN
      • EntityKind::TOPIC
      • EntityKind::PARTICIPANT
      • EntityKind::DATAWRITER
      • EntityKind::DATAREADER
      • EntityKind::LOCATOR
  • 5.4.8. StatusLevel
    • StatusLevel
      • StatusLevel::OK_STATUS
      • StatusLevel::WARNING_STATUS
      • StatusLevel::ERROR_STATUS
  • 5.4.9. Graph
    • Graph
  • 5.4.10. Info
    • Info
  • 5.4.11. StatisticKind
    • StatisticKind
      • StatisticKind::NONE
      • StatisticKind::MEAN
      • StatisticKind::STANDARD_DEVIATION
      • StatisticKind::MAX
      • StatisticKind::MIN
      • StatisticKind::MEDIAN
      • StatisticKind::COUNT
      • StatisticKind::SUM
  • 5.4.12. StatisticsData
    • StatisticsData
  • 5.4.13. StatusData
    • MonitorServiceSample
    • ProxySample
    • ConnectionListSample
    • IncompatibleQosSample
    • InconsistentTopicSample
    • LivelinessLostSample
    • LivelinessChangedSample
    • DeadlineMissedSample
    • SampleLostSample
  • 5.4.14. Timestamp
    • Timestamp
  • 5.4.15. JSON Tags
    • ACTUAL_DUMP_VERSION
  • 5.4.16. AlertInfo
    • AlertInfo
      • AlertInfo::AlertInfo()
      • AlertInfo::AlertInfo()
      • AlertInfo::reset()
      • AlertInfo::entity_matches()
      • AlertInfo::value_triggers()
      • AlertInfo::value_triggers()
      • AlertInfo::time_allows_trigger()
      • AlertInfo::check_trigger_conditions()
      • AlertInfo::check_trigger_conditions()
      • AlertInfo::check_timeout()
      • AlertInfo::trigger()
      • AlertInfo::set_id()
      • AlertInfo::get_alert_id()
      • AlertInfo::get_alert_kind()
      • AlertInfo::get_domain_id()
      • AlertInfo::get_alert_name()
      • AlertInfo::get_host_name()
      • AlertInfo::get_user_name()
      • AlertInfo::get_topic_name()
      • AlertInfo::get_trigger_threshold()
      • AlertInfo::get_time_between_triggers()
      • AlertInfo::add_notifier()
      • AlertInfo::remove_notifier()
      • AlertInfo::get_notifiers()
  • 5.4.17. Notifier
    • Notifier