mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-29 04:57:52 +00:00
Code Issues Releases Wiki Activity

[#3253] Doxygen clean up

Browse Source 
../../../../doc/devel/Doxyfile
    Added perfmon dir

modified:
    alarm.h
    alarm_store.h
    monitored_duration_store.h
This commit is contained in:
Thomas Markwalder 2024-02-29 13:40:27 -05:00
parent 94b11b9bf8
commit 5d331f46ff
4 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/devel/Doxyfile
View File

@ -950,6 +950,7 @@ INPUT = ../../src/bin/agent \
../../src/hooks/dhcp/flex_option \
../../src/hooks/dhcp/high_availability \
../../src/hooks/dhcp/lease_cmds \
../../src/hooks/dhcp/perfmon \
../../src/hooks/dhcp/stat_cmds \
../../src/hooks/dhcp/user_chk \
../../src/lib/asiodns \

10
src/hooks/dhcp/perfmon/alarm.h
View File

@ -33,10 +33,10 @@ public:
/// @param response_type message type of the response packet
/// @param start_event_label label of the start event
/// @param end_event_label label of the end event
/// @param SubnetID subnet_id id of the selected subnet
/// @param subnet_id SubnetID of the selected subnet
/// @param low_water threshold below which the average duration must fall to clear the alarm
/// @brief high_water threshold above which the average duration must rise to trigger the alarm.
/// @brief enabled true sets state to CLEAR, otherwise DISABLED, defaults to true.
/// @param high_water threshold above which the average duration must rise to trigger the alarm.
/// @param enabled true sets state to CLEAR, otherwise DISABLED, defaults to true.
Alarm(uint16_t family, uint8_t query_type, uint8_t response_type,
const std::string& start_event_label, const std::string& end_event_label,
dhcp::SubnetID subnet_id,
@ -46,8 +46,8 @@ public:
///
/// @param key composite key that identifies the alarm
/// @param low_water threshold below which the average duration must fall to clear the alarm
/// @brief high_water threshold above which the average duration must rise to trigger the alarm.
/// @brief enabled true sets state to CLEAR, otherwise DISABLED, defaults to true.
/// @param high_water threshold above which the average duration must rise to trigger the alarm.
/// @param enabled true sets state to CLEAR, otherwise DISABLED, defaults to true.
Alarm(const DurationKey& key, const Duration& low_water, const Duration& high_water, bool enabled = true);
/// @brief Destructor

12
src/hooks/dhcp/perfmon/alarm_store.h
View File

@ -38,9 +38,9 @@ struct AlarmPrimaryKeyTag { };
/// @brief A multi index container holding pointers to Alarms.
///
/// The durations in the container may be accessed using different indexes:
/// - using the full key index
/// <TBD>
/// The alarms in the container may be accessed using different indexes:
/// - using the index on DurationKey members, AlarmPrimaryKeyTag
/// - others to follow based on API
///
/// Indexes can be accessed using the index number (from 0 to n) or a
/// name tag. It is recommended to use the tags to access indexes as
@ -68,7 +68,7 @@ typedef boost::shared_ptr<AlarmCollection> AlarmCollectionPtr;
///
/// Provides essential CRUD functions for managing a collection of
/// Alarms. Additionally there are finders that can return
/// durations by DurationKey <TBD>
/// durations by DurationKey (others are TBD).
/// All finders return copies of the durations found, rather than the
/// stored duration itself.
class AlarmStore {
@ -106,8 +106,8 @@ public:
///
/// @param key key value of the Alarm to create.
/// @param low_water threshold below which the average duration must fall to clear the alarm
/// @brief high_water threshold above which the average duration must rise to trigger the alarm.
/// @brief enabled true sets state to CLEAR, otherwise DISABLED, defaults to true.
/// @param high_water threshold above which the average duration must rise to trigger the alarm.
/// @param enabled true sets state to CLEAR, otherwise DISABLED, defaults to true.
///
/// @return pointer to the newly created Alarm.
/// @throw DuplicateAlarm if a duration for the given key already exists in

6
src/hooks/dhcp/perfmon/monitored_duration_store.h
View File

@ -39,8 +39,8 @@ struct DurationKeyTag { };
/// @brief A multi index container holding pointers to MonitoredDurations.
///
/// The durations in the container may be accessed using different indexes:
/// - using the full key index
/// <TBD>
/// - using the index on DurationKey members, DurationKeyTag
/// - others to follow based on API
///
/// Indexes can be accessed using the index number (from 0 to n) or a
/// name tag. It is recommended to use the tags to access indexes as
@ -68,7 +68,7 @@ typedef boost::shared_ptr<MonitoredDurationCollection> MonitoredDurationCollecti
///
/// Provides essential CRUD functions for managing a collection of
/// MonitoredDurations. Additionally there are finders that can return
/// durations by DurationKey <TBD>
/// durations by DurationKey (others are TBD)
/// All finders return copies of the durations found, rather than the
/// stored duration itself.
class MonitoredDurationStore {