X-Git-Url: https://git.teslayout.com/public/public/public/?a=blobdiff_plain;f=include%2Fanna%2Fdiameter%2Fstack%2FEngine.hpp;h=e15ac1baea38d71e5abd14f7d69649df02d61a2b;hb=5a6cba5fde2b2f538a7515f8293cc0a8d9589dfa;hp=8f4b9fc7358d61ffa922ff3141a1ae05170adc12;hpb=39033fd99e58e994a5e98c1060dcc79e0d81f9c9;p=anna.git diff --git a/include/anna/diameter/stack/Engine.hpp b/include/anna/diameter/stack/Engine.hpp index 8f4b9fc..e15ac1b 100644 --- a/include/anna/diameter/stack/Engine.hpp +++ b/include/anna/diameter/stack/Engine.hpp @@ -1,37 +1,9 @@ -// 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 @@ -67,30 +39,31 @@ namespace stack { class Engine : public anna::Singleton { - const anna::xml::DTDMemory * getDictionariesDTD() const throw() { return &a_dtd; } + const anna::xml::DTDMemory * getDictionariesDTD() const { return &a_dtd; } public: - typedef std::map stack_container; + typedef std::map stack_container; typedef stack_container::const_iterator const_stack_iterator; typedef stack_container::iterator stack_iterator; // 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 */ - const Dictionary * getDictionary(int stackId) const throw(); + const Dictionary * getDictionary(unsigned int stackId) const ; /** Beginning stack iterator */ - const_stack_iterator stack_begin() const throw() { return a_stacks.begin(); } + const_stack_iterator stack_begin() const { return a_stacks.begin(); } /** Ending stack iterator */ - const_stack_iterator stack_end() const throw() { return a_stacks.end(); } + const_stack_iterator stack_end() const { return a_stacks.end(); } /** Stack size */ - int stack_size() const throw() { return a_stacks.size(); } + int stack_size() const { return a_stacks.size(); } // helpers /** @@ -98,14 +71,16 @@ public: * * @return Boolean about empty stack condition */ - bool isEmpty(void) const throw() { return (!a_stacks.size()); } + bool isEmpty(void) const { return (!a_stacks.size()); } /** * 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 ; // set @@ -123,7 +98,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,12 +111,24 @@ 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 */ - Dictionary * createDictionary(int stackId, const std::string & xmlPathFile = "") throw(anna::RuntimeException); + Dictionary * createDictionary(unsigned int stackId, const std::string & xmlPathFile = "") noexcept(false); + + /** + * 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) noexcept(false); /** * Loads an XML dictionary document over the diameter stack identifiers (one or more stack id's). @@ -151,7 +138,7 @@ public: * @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 & stacks, const std::string & xmlPathFile) throw(anna::RuntimeException); + void loadDictionary(const std::vector & stacks, const std::string & xmlPathFile) noexcept(false); /** * Loads an XML dictionary document over all the diameter engine registered stacks. When more than one stack id is @@ -160,19 +147,19 @@ public: * * @param xmlPathFile Path file to the xml document which represents the diameter dictionary. */ - void loadDictionary(const std::string & xmlPathFile) throw(anna::RuntimeException); + void loadDictionary(const std::string & xmlPathFile) noexcept(false); /** * Remove all stacks registered on diameter stack engine */ - void removeStacks(void) throw() { a_stacks.clear(); } + void removeStacks(void) { a_stacks.clear(); } /** * Remove the stack provided. * * @param stackId Stack identifier for created dictionary */ - void removeStack(int stackId) throw(); + void removeStack(unsigned int stackId) ; private: