From: JINMEI Tatuya Date: Tue, 9 Apr 2013 21:20:57 +0000 (-0700) Subject: [2831] more explicitly clarify passing NULL to setNamedAddress. X-Git-Tag: bind10-1.2.0beta1-release~457^2~86 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=0f5e915ace1384308c9976c5f20dd49d5b2d05ab;p=thirdparty%2Fkea.git [2831] more explicitly clarify passing NULL to setNamedAddress. --- diff --git a/src/lib/util/memory_segment.h b/src/lib/util/memory_segment.h index e61f6d6c07..1533613df0 100644 --- a/src/lib/util/memory_segment.h +++ b/src/lib/util/memory_segment.h @@ -159,7 +159,11 @@ public: /// to \c allocate(). The actual implementation is encouraged to detect /// violation of this restriction and signal it with an exception, but /// it's not an API requirement. It's generally the caller's - /// responsibility to meet the restriction. + /// responsibility to meet the restriction. Note that NULL is allowed + /// as \c addr even if it wouldn't be considered to "belong to" the + /// segment in its normal sense; it can be used to indicate that memory + /// has not been allocated for the specified name. A subsequent call + /// to \c getNamedAddress() will return NULL for that name. /// /// \note Naming an address is intentionally separated from allocation /// so that, for example, one module of a program can name a memory