Commit e8a9043a authored by Michal 'vorner' Vaner's avatar Michal 'vorner' Vaner
Browse files

[2930] Replace example for a more obvious one

parent cd146974
...@@ -440,10 +440,11 @@ public: ...@@ -440,10 +440,11 @@ public:
/// users should receive the notification. Only the users that /// users should receive the notification. Only the users that
/// subscribed to notifications on the same group receive it. /// subscribed to notifications on the same group receive it.
/// \param name The name of the event to notify about (for example /// \param name The name of the event to notify about (for example
/// `config_changed`). /// `new_group_member`).
/// \param params Other parameters that describe the event. This might /// \param params Other parameters that describe the event. This might
/// be, for example, the new configuration value. This can be any /// be, for example, the ID of the new member and the name of the
/// data element, but it is common for it to be map. /// group. This can be any data element, but it is common for it to be
/// map.
void notify(const std::string& notification_group, void notify(const std::string& notification_group,
const std::string& name, const std::string& name,
const isc::data::ConstElementPtr& params = const isc::data::ConstElementPtr& params =
......
...@@ -556,10 +556,11 @@ class ModuleCCSession(ConfigData): ...@@ -556,10 +556,11 @@ class ModuleCCSession(ConfigData):
what users should receive the notification. Only users that what users should receive the notification. Only users that
subscribed to notifications on the same group receive it. subscribed to notifications on the same group receive it.
- event_name (string): The name of the event to notify about (for - event_name (string): The name of the event to notify about (for
example `config_changed`). example `new_group_member`).
- params: Other parameters that describe the event. This might be, for - params: Other parameters that describe the event. This might be, for
example, the new configuration value. This can be any data that can example, the ID of the new member and the name of the group. This can
be sent over the isc.cc.Session, but it is common for it to be dict. be any data that can be sent over the isc.cc.Session, but it is
common for it to be dict.
Returns: Nothing Returns: Nothing
""" """
notification = [event_name] notification = [event_name]
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment