Added some comments concerning stack allocation and references

This commit is contained in:
Pavel Kirienko
2015-05-29 22:23:41 +03:00
parent af09237dd2
commit d8c096430f
3 changed files with 14 additions and 1 deletions
@@ -93,6 +93,9 @@ public:
ServiceCallID getCallID() const { return call_id_; }
/**
* Returned reference points to a stack-allocated object.
*/
const ResponseFieldType& getResponse() const { return response_; }
ResponseFieldType& getResponse() { return response_; }
};
@@ -201,6 +204,10 @@ public:
* This class can manage multiple concurrent calls to the same or different remote servers. Number of concurrent
* calls is limited only by amount of available pool memory.
*
* Note that the reference passed to the callback points to a stack-allocated object, which means that the
* reference invalidates once the callback returns. If you want to use this object after the callback execution,
* you need to copy it somewhere.
*
* @tparam DataType_ Service data type.
*
* @tparam Callback_ Service response will be delivered through the callback of this type.