From 2dd13851454b7ed734a0d080b2932a0e92d10f0d Mon Sep 17 00:00:00 2001 From: Eduardo Ramos Testillano Date: Sat, 4 Apr 2015 21:01:51 +0200 Subject: [PATCH] Add recommendation for stack id: use the application id --- include/anna/diameter/stack/Engine.hpp | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/include/anna/diameter/stack/Engine.hpp b/include/anna/diameter/stack/Engine.hpp index 8f4b9fc..165d779 100644 --- a/include/anna/diameter/stack/Engine.hpp +++ b/include/anna/diameter/stack/Engine.hpp @@ -78,7 +78,8 @@ public: // get /** - * Returns the dictionary registered with the provided identifier + * Returns the dictionary registered with the provided identifier, which commonly + * is the 'Application-Id'. * * @param stackId Stack identifier. * @return Dictionary reference, NULL if no stack found @@ -123,7 +124,7 @@ public: * Dictionary * d = engine->createDictionary(MMS_STACK_ID); * // Loading data: * d->load("/var/tmp/mms.xml"); - * + * ... * Method 3 - Create and then, load data through Dictionary API (*): * Dictionary * d = engine->createDictionary(MMS_STACK_ID); * // Loading data: @@ -136,7 +137,8 @@ public: * * * - * @param stackId Stack identifier for created dictionary. + * @param stackId Stack identifier for created dictionary. We recommend to use the Diameter 'Application-Id' unless + * the application is going to use dictionaries covering different applications (which is not very usual). * @param xmlPathFile Path file to the xml document which represents the diameter dictionary. * * @return Dictionary registered. When exception happen, dictionary can be accessed by #getDictionary -- 2.20.1