X-Git-Url: https://git.teslayout.com/public/public/public/?a=blobdiff_plain;f=include%2Fanna%2Fdiameter%2Fcodec%2FMessage.hpp;h=fd44c4276015318739791910fa357410dacabd7e;hb=93366a0bda79e6fd6e7dad6316bfcf8cc82f5731;hp=7600b6edf8cbf565aa76f8e00201e9cec68feffe;hpb=884501d2411bc4fdfafae65948262c959e068d7d;p=anna.git diff --git a/include/anna/diameter/codec/Message.hpp b/include/anna/diameter/codec/Message.hpp index 7600b6e..fd44c42 100644 --- a/include/anna/diameter/codec/Message.hpp +++ b/include/anna/diameter/codec/Message.hpp @@ -1,37 +1,9 @@ -// ANNA - Anna is Not 'N' Anymore -// -// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo -// -// https://bitbucket.org/testillano/anna -// -// 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 Google Inc. 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_codec_Message_hpp @@ -146,7 +118,31 @@ class Message { bool flagsOK(int &rc) const throw(); // flags coherence regarding dictionary. Only must be called when Message is identified at the dictionary. int addChild(Avp *avp) throw() { return Avp::addChild(a_avps, a_insertionPositionForChilds, avp); } const anna::diameter::stack::Command *getStackCommand(CommandId id) const throw(anna::RuntimeException); - Avp * addFailedAVP() throw(); // returns Failed-AVP if exists, creates it when missing + + void setFailedAvp(const parent_t &parent, AvpId wrong, const char *wrongName = NULL) throw(anna::RuntimeException); + // During message decoding and validation, the first wrong avp is stored and all the tracking is managed to find out its + // nested path for the case of grouped avps with wrong avps inside. Remember the RFC 6733, section 7.5: + // + // In the case where the offending AVP is embedded within a Grouped AVP, + // the Failed-AVP MAY contain the grouped AVP, which in turn contains + // the single offending AVP. The same method MAY be employed if the + // grouped AVP itself is embedded in yet another grouped AVP and so on. + // In this case, the Failed-AVP MAY contain the grouped AVP hierarchy up + // to the single offending AVP. This enables the recipient to detect + // the location of the offending AVP when embedded in a group. + // + // The first wrong avp found will set the final result code, as the RFC recommends: + // + // The value of the Result-Code AVP will provide information on the reason + // for the Failed-AVP AVP. A Diameter answer message SHOULD contain an + // instance of the Failed-AVP AVP that corresponds to the error + // indicated by the Result-Code AVP. For practical purposes, this + // Failed-AVP would typically refer to the first AVP processing error + // that a Diameter node encounters. + // + // The message keeps the list (reverse order) of avps hierarchy (in case of grouping) for the final Failed-AVP construction, + // which is done at the end of decoding or validation, and only the first wrong avp is stored with its corresponding path. + protected: @@ -256,10 +252,21 @@ public: void setPotentiallyReTransmittedMessageBit(bool activate = true) throw() { if(activate) a_flags |= TBitMask; else a_flags &= (~TBitMask); } /** - Sets the message application id + Sets the message application id. + + The codec engine could be configured to force a stack selection based in this field value: see #selectStackWithApplicationId. + In multistack applications (which also shall be monothreaded), you only have to take care about how to apply this method: the thing + is that you must not interleave message builds which belongs to different stacks. For example, you could think about setting the + message header for message A using stack A. Then, start to add the message header fields for a second message B using another stack B. + Following you would add the message A avps, but then, the stack is not going to be automatically changed (this is only done through this + method). The result could be unexpected when adding/encoding messages with a dictionary which does not correspond. + + @warning do not interleave build/encode operations between different messages which uses different stacks over the same codec engine. + It seems common sense, but it is not bad to advice about this. + @param aid Application-id. */ - void setApplicationId(U32 aid) throw() { a_applicationId = aid; } + void setApplicationId(U32 aid) throw(); /** Sets the message hop-by-hop @@ -340,7 +347,12 @@ public: Result-Code and/or Failed-AVP AVPs if proceed, but be aware of DIAMETER_COMMAND_UNSUPPORTED Result-Code, because becomes impossible to fix (Session-Id SHOULD appear immediately following the Diameter header, and #fix do this manually even if no information about the command structure is known, but perhaps another fixed AVPs could not comply... use #getResultCode to find out this situation before - using #setStandardToAnswer). + using #setStandardToAnswer). Anyway, application could add another Failed-AVP content no detected internally, for example: + DIAMETER_CONTRADICTING_AVPS or DIAMETER_INVALID_AVP_BIT_COMBO). Also, application could add more Failed-AVP avps with other + wrong avps, or accumulate wrong avps inside the one and only Failed-AVP managed by the stack. The standard is open to add multiple + avps inside Failed-AVP or multiple Failed-AVP avps with single or multiple avps inside. This depends on application criteria regarding + other nodes. However, internally the Anna::diameter stack only provides one Failed-AVP with the first wrong avp found, as RFC 6733 says + in section 7.5. If application decoding and/or validation operations are ok, user may search for other problems and put the appropiate Result-Code. For example, DIAMETER_TOO_BUSY (3004) depends on congestion issues at business layer and cannot be decided with the only message @@ -405,35 +417,6 @@ public: int getResultCode() const throw(); - /** - Adds a new AVP within a Failed-AVP over an answer message (for requests, do nothing). - If Failed-AVP AVP doesn't exists, is added and then filled (added within) with the value provided (empty AVP id representantion). - If Failed-AVP AVP already exists, is filled (added within) with the value provided (empty AVP id representantion). - - This method is internally used during #decode and/or #valid procedures in order to build automatic answers. - - @param id Avp identifier as pair (code,vendor-id). - - @return Pointer to the new AVP added within Failed-AVP, to make easy data-part accessif needed. - */ - Avp * setNewFailedAvp(AvpId id) throw(anna::RuntimeException) { if(isRequest()) return NULL; return (addFailedAVP()->addAvp(id)); } - - /** - Adds a new AVP within a Failed-AVP over an answer message (for requests, do nothing). - If Failed-AVP AVP doesn't exists, is added and then filled (added within) with the value provided (empty AVP id representantion). - If Failed-AVP AVP already exists, is filled (added within) with the value provided (empty AVP id representantion). - - This method is internally used during #decode and/or #valid procedures in order to build automatic answers, but application - could call this for set another Failed-AVP content no detected by these methods, for example: DIAMETER_CONTRADICTING_AVPS or - DIAMETER_INVALID_AVP_BIT_COMBO). - - @param id Avp identifier as pair (code,vendor-id). - - @return Pointer to the new AVP added within Failed-AVP, to make easy data-part accessif needed. - */ - Avp * setNewFailedAvp(Avp *avp) throw() { if(!avp || isRequest()) return NULL; return (addFailedAVP()->addAvp(avp)); } - - /** Adds an avp child providing its identifier and reserve internal memory it. @@ -750,7 +733,7 @@ public: std::string asXMLString() const throw(); /** - Comparison operator + Comparison operator by mean serialization @param m1 Instance 1 for Message class @param m2 Instance 2 for Message class