X-Git-Url: https://git.teslayout.com/public/public/public/?a=blobdiff_plain;f=include%2Fanna%2Fdiameter%2Fcodec%2FMessage.hpp;h=87e1012c3d343dd344e152679ef03885c10a4414;hb=0ce74f51388826845727411a7d37d841111ede84;hp=fb519b55c70ba62abe83319a566a62649ee17f49;hpb=8da04b5c6567907540a54d440aecc2b7d70e079b;p=anna.git diff --git a/include/anna/diameter/codec/Message.hpp b/include/anna/diameter/codec/Message.hpp index fb519b5..87e1012 100644 --- a/include/anna/diameter/codec/Message.hpp +++ b/include/anna/diameter/codec/Message.hpp @@ -146,9 +146,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 * addTheFailedAVP() throw(); // returns the Failed-AVP if exists, creates it when missing. The method could be named 'addFailedAVP' - // but we consider this better because only one instance (as RFC 6733 says in section 7.5) will be - // added by internal procedures (although, the application could obviously add more). + + 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: @@ -342,7 +364,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 @@ -407,34 +434,6 @@ public: int getResultCode() const throw(); - /** - Adds the wrong AVP within the 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 probably filled by a previous found error, but anyway this is verified and if empty then 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). 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 (see section 7.5 of RFC 6733). - - @param id Avp identifier as pair (code,vendor-id). - - @return Pointer to the new AVP added within Failed-AVP, to make easy data-part access if needed. - */ - Avp * setFailedAvp(AvpId id) throw(anna::RuntimeException); - - /** - Same as #setFailedAvp(AvpId id) but providing an avp pointer with the needed information - - @param avp Pointer to the added wrong avp - - @return Pointer to the new AVP added within Failed-AVP, to make easy data-part access if needed. - */ - Avp * setFailedAvp(Avp *avp) throw(anna::RuntimeException); - - - /** Adds an avp child providing its identifier and reserve internal memory it.