summaryrefslogtreecommitdiffstats
path: root/src/lib/dhcpsrv/lease.h
diff options
context:
space:
mode:
authorMarcin Siodelski <marcin@isc.org>2013-11-15 13:45:56 +0100
committerMarcin Siodelski <marcin@isc.org>2013-11-15 13:45:56 +0100
commit3328fb3879e398494bf86d8e74c36188426178aa (patch)
tree0cce1c38e71ae2d233aaba4c80caad511d7e9e41 /src/lib/dhcpsrv/lease.h
parent[2940] Moved the Memfile backend tests to a generic class. (diff)
downloadkea-3328fb3879e398494bf86d8e74c36188426178aa.tar.xz
kea-3328fb3879e398494bf86d8e74c36188426178aa.zip
[2940] Addressed review comments.
Diffstat (limited to 'src/lib/dhcpsrv/lease.h')
-rw-r--r--src/lib/dhcpsrv/lease.h11
1 files changed, 8 insertions, 3 deletions
diff --git a/src/lib/dhcpsrv/lease.h b/src/lib/dhcpsrv/lease.h
index 3f98491f8b..3734e9f2a9 100644
--- a/src/lib/dhcpsrv/lease.h
+++ b/src/lib/dhcpsrv/lease.h
@@ -211,9 +211,14 @@ struct Lease4 : public Lease {
/// @brief Returns a client identifier.
///
- /// @return A client identifier as vector, or an empty vector if client
- /// identifier is NULL.
- std::vector<uint8_t> getClientIdVector() const;
+ /// @warning Since the function returns the reference to a vector (not a
+ /// copy), the returned object should be used with caution because it will
+ /// remain valid only for the period of time when an object which returned
+ /// it exists.
+ ///
+ /// @return A reference to a vector holding client identifier,
+ /// or an empty vector if client identifier is NULL.
+ const std::vector<uint8_t>& getClientIdVector() const;
/// @brief Assignment operator.
///