-// ANNA - Anna is Not Nothingness Anymore
-//
-// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
-//
-// http://redmine.teslayout.com/projects/anna-suite
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions
-// are met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of the copyright holder nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-//
-// Authors: eduardo.ramos.testillano@gmail.com
-// cisco.tierra@gmail.com
+// ANNA - Anna is Not Nothingness Anymore //
+// //
+// (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo //
+// //
+// See project site at http://redmine.teslayout.com/projects/anna-suite //
+// See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
#ifndef anna_diameter_stack_Engine_hpp
public:
- typedef std::map<int, Dictionary*> stack_container;
+ typedef std::map<unsigned int, Dictionary*> stack_container;
typedef stack_container::const_iterator const_stack_iterator;
typedef stack_container::iterator stack_iterator;
* @param stackId Stack identifier.
* @return Dictionary reference, NULL if no stack found
*/
- const Dictionary * getDictionary(int stackId) const throw();
+ const Dictionary * getDictionary(unsigned int stackId) const throw();
/** Beginning stack iterator */
const_stack_iterator stack_begin() const throw() { return a_stacks.begin(); }
/**
* Class string representation
*
+ * @param all Complete engine information versus only stacks list with its ids and dictionary names
+ *
* @return String with class content
*/
- std::string asString(void) const throw();
+ std::string asString(bool all = true) const throw();
// set
*
* @return Dictionary registered. When exception happen, dictionary can be accessed by #getDictionary
*/
- Dictionary * createDictionary(int stackId, const std::string & xmlPathFile = "") throw(anna::RuntimeException);
+ Dictionary * createDictionary(unsigned int stackId, const std::string & xmlPathFile = "") throw(anna::RuntimeException);
+
+ /**
+ * Register a externally created Dictionary or a derived class from Dictionary
+ *
+ * @param stackId Stack identifier for provided 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 dictionary Externally created dictionary
+ *
+ * @return Dictionary registered. When exception happen, dictionary can be accessed by #getDictionary
+ */
+ Dictionary * registerDictionary(unsigned int stackId, Dictionary *dictionary) throw(anna::RuntimeException);
/**
* Loads an XML dictionary document over the diameter stack identifiers (one or more stack id's).
* @param stacks Stacks identifiers over which the dictionary will be load.
* @param xmlPathFile Path file to the xml document which represents the diameter dictionary.
*/
- void loadDictionary(const std::vector<int> & stacks, const std::string & xmlPathFile) throw(anna::RuntimeException);
+ void loadDictionary(const std::vector<unsigned int> & stacks, const std::string & xmlPathFile) throw(anna::RuntimeException);
/**
* Loads an XML dictionary document over all the diameter engine registered stacks. When more than one stack id is
*
* @param stackId Stack identifier for created dictionary
*/
- void removeStack(int stackId) throw();
+ void removeStack(unsigned int stackId) throw();
private: