Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Warning fix due to missing description #368

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions interfaces/IStore2.h
Original file line number Diff line number Diff line change
Expand Up @@ -44,19 +44,43 @@ namespace Exchange {
~INotification() override = default;

// @alt onValueChanged
// @brief Event method to notify value change
// @param scope: Scope of the value changed
// @param ns: Namespace of the value changed
// @param key: Key paired with changed value
// @param value: Changed value
virtual void ValueChanged(const ScopeType scope, const string& ns /* @text:namespace */, const string& key, const string& value) = 0;
};

virtual uint32_t Register(Exchange::IStore2::INotification* notification) = 0;
virtual uint32_t Unregister(Exchange::IStore2::INotification* notification) = 0;

// @alt setValue
// @brief Set value for the given key
// @param scope: Scope of the value
// @param ns: Namespace of the value
// @param key: Key against the value to be set
// @param value: Value to be set against given key
// @param ttl: TTL value
virtual uint32_t SetValue(const ScopeType scope, const string& ns /* @text:namespace */, const string& key, const string& value, const uint32_t ttl) = 0;
// @alt getValue
// @brief Get value of the given key
// @param scope: Scope of the value
// @param ns: Namespace of the value
// @param key: Key against the value to be get
// @param value: Value to be get against given key
// @param ttl: TTL value
virtual uint32_t GetValue(const ScopeType scope, const string& ns /* @text:namespace */, const string& key, string& value /* @out */, uint32_t& ttl /* @out */) = 0;
// @alt deleteKey
// @brief Delete given key
// @param scope: Scope of the value
// @param ns: Namespace of the value
// @param key: Key to be deleted
virtual uint32_t DeleteKey(const ScopeType scope, const string& ns /* @text:namespace */, const string& key) = 0;
// @alt deleteNamespace
// @brief Delete given namespace
// @param scope: Scope of the value
// @param ns: Namespace to be deleted
virtual uint32_t DeleteNamespace(const ScopeType scope, const string& ns /* @text:namespace */) = 0;
};

Expand Down