Base protocol codec for comm::Engine. Supported retransmissions
[anna.git] / source / diameter / codec / Message.cpp
index 4938a03..b9c4fbd 100644 (file)
@@ -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 //
 
 
 // Local
@@ -84,7 +56,7 @@ const U8 Message::TBitMask(0x10);
 //------------------------------------------------------------------------------
 //----------------------------------------------------------- Message::Message()
 //------------------------------------------------------------------------------
-Message::Message() : a_forCode(true) {
+Message::Message(Engine *engine) : a_engine(engine), a_forCode(true) {
   initialize();
 }
 
@@ -92,7 +64,7 @@ Message::Message() : a_forCode(true) {
 //------------------------------------------------------------------------------
 //----------------------------------------------------------- Message::Message()
 //------------------------------------------------------------------------------
-Message::Message(CommandId id) : a_forCode(true) {
+Message::Message(CommandId id, Engine *engine) : a_engine(engine), a_forCode(true) {
   initialize();
   setId(id);
 }
@@ -110,7 +82,11 @@ Message::~Message() {
 //--------------------------------------------------------- Message::getEngine()
 //------------------------------------------------------------------------------
 Engine * Message::getEngine() const throw(anna::RuntimeException) {
-  return a_engine ? a_engine : (a_engine = anna::functions::component <Engine> (ANNA_FILE_LOCATION));
+  if(!a_engine)
+    throw anna::RuntimeException("Invalid codec engine reference (NULL)", ANNA_FILE_LOCATION);
+
+  return a_engine;
+
 }
 
 
@@ -118,7 +94,6 @@ Engine * Message::getEngine() const throw(anna::RuntimeException) {
 //-------------------------------------------------------- Message::initialize()
 //------------------------------------------------------------------------------
 void Message::initialize() throw() {
-  a_engine = NULL;
   a_version = 1;
   a_id = CommandId(0, false);
   a_flags = 0x00;
@@ -230,11 +205,11 @@ void Message::setId(const char *name) throw(anna::RuntimeException) {
 //------------------------------------------------------------------------------
 //-------------------------------------------------- Message::setApplicationId()
 //------------------------------------------------------------------------------
-void Message::setApplicationId(U32 aid) throw() {
+void Message::setApplicationId(U32 aid) throw(anna::RuntimeException) {
   a_applicationId = aid;
 
   // Default behaviour:
-  if (!getEngine()->selectStackWithApplicationId()) return;
+  if (!getEngine()->hasSelectStackWithApplicationId()) return;
 
   // Adapts for Application-ID stack identifier:
   getEngine()->setDictionary(aid);
@@ -345,10 +320,9 @@ void Message::decode(const anna::DataBlock &db, Message *ptrAnswer) throw(anna::
 
   U24 code = DECODE3BYTES_INDX_VALUETYPE(buffer, 5, U24);
 
-  // This is called before setId, and in general before any operation which needs to know about the stack elements.
-  setApplicationId(DECODE4BYTES_INDX_VALUETYPE(buffer, 8, U32)); // centralize set, because it could be used for stack selection.
+  a_id = CommandId(code, requestBit() /* based on a_flags */);
 
-  setId(CommandId(code, requestBit() /* based on a_flags */));
+  setApplicationId(DECODE4BYTES_INDX_VALUETYPE(buffer, 8, U32)); // centralize set, because it could be used for stack selection.
 
   a_hopByHop = DECODE4BYTES_INDX_VALUETYPE(buffer, 12, U32);
 
@@ -392,7 +366,7 @@ void Message::decode(const anna::DataBlock &db, Message *ptrAnswer) throw(anna::
 
   while(avpPos < dataBytes) {
     try {
-      avp =  getEngine()->allocateAvp();
+      avp =  getEngine()->createAvp(NULL);
       db_aux.assign(startData + avpPos, dataBytes - avpPos /* is valid to pass total length (indeed i don't know the real avp length) because it will be limited and this has deep copy disabled (no memory is reserved) */);
       avp -> decode(db_aux, parent, answer);
     } catch(anna::RuntimeException &ex) {
@@ -660,7 +634,7 @@ const anna::DataBlock & Message::code() throw(anna::RuntimeException) {
   // Pre-Validation
   Engine::ValidationMode::_v vmode = getEngine()->getValidationMode();
 
-  if((vmode == Engine::ValidationMode::BeforeCoding) || (vmode == Engine::ValidationMode::Always)) {
+  if((vmode == Engine::ValidationMode::BeforeEncoding) || (vmode == Engine::ValidationMode::Always)) {
     if(!valid())
       throw anna::RuntimeException("Try to encode an invalid message. See previous report on warning-level traces", ANNA_FILE_LOCATION);
   }
@@ -668,7 +642,7 @@ const anna::DataBlock & Message::code() throw(anna::RuntimeException) {
   // Pre-Fixing
   Engine::FixMode::_v fmode = getEngine()->getFixMode();
 
-  if((fmode == Engine::FixMode::BeforeCoding) || (fmode == Engine::FixMode::Always)) fix();
+  if((fmode == Engine::FixMode::BeforeEncoding) || (fmode == Engine::FixMode::Always)) fix();
 
   // Trace
   LOGDEBUG(
@@ -771,6 +745,9 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
   int i_aux;
   unsigned int u_aux;
 
+  // Clear the message
+  clear();
+
   if(version) {
     i_aux = version->getIntegerValue();
 
@@ -784,8 +761,8 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
   }
 
   // Application-id
-  // This is called before setId, and in general before any operation which needs to know about the stack elements.
-  setApplicationId(appid->getIntegerValue()); // this could set the dictionary...
+  // This is called before any operation which needs to know about the stack elements (this could set the dictionary)
+  setApplicationId(appid->getIntegerValue());
 
   // Dictionary
   const stack::Dictionary * dictionary = getEngine()->getDictionary();
@@ -816,7 +793,7 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
     }
 
-    setId(stackCommand->getId());
+    setId(stackCommand->getId(), false /* don't clear */);
     // 'P', 'E' and 'T' flags:
     bool activateP = pbit ? (pbit->getValue() == "yes") : false;
     bool activateE = ebit ? (ebit->getValue() == "yes") : false;
@@ -867,7 +844,7 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
     a_flags = i_aux;
     int flagsBCK = a_flags;
     // Final assignments
-    setId(CommandId(u_code, requestBit() /* based on a_flags */));
+    a_id = CommandId(u_code, requestBit() /* based on a_flags */);
     // Flags could have been updated regarding dictionary, but during parsing we must respect xml file:
     a_flags = flagsBCK;
   }
@@ -914,7 +891,7 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
     }
 
     try {
-      avp =  getEngine()->allocateAvp();
+      avp =  getEngine()->createAvp(NULL);
       avp -> fromXML(*it);
     } catch(anna::RuntimeException &ex) {
       getEngine()->releaseAvp(avp);