1 // ANNA - Anna is Not Nothingness Anymore //
3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo //
5 // See project site at http://redmine.teslayout.com/projects/anna-suite //
6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
9 #ifndef anna_diameter_codec_Message_hpp
10 #define anna_diameter_codec_Message_hpp
14 #include <anna/config/defines.hpp>
15 #include <anna/diameter/defines.hpp>
16 #include <anna/diameter/codec/Avp.hpp>
17 #include <anna/diameter/helpers/base/defines.hpp>
19 #include <anna/core/DataBlock.hpp>
20 #include <anna/core/RuntimeException.hpp>
25 //------------------------------------------------------------------------------
26 //---------------------------------------------------------------------- #define
27 //------------------------------------------------------------------------------
49 * Diameter message generic container
51 * RFC 3588 Diameter Based Protocol September 2003
54 * A summary of the Diameter header format is shown below. The fields
55 * are transmitted in network byte order.
58 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
59 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
60 * | Version | Message Length |
61 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
62 * | command flags | Command-Code |
63 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
65 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
66 * | Hop-by-Hop Identifier |
67 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
68 * | End-to-End Identifier |
69 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
71 * +-+-+-+-+-+-+-+-+-+-+-+-+-
77 CommandId a_id; // code and request indicator
82 avp_container a_avps; // childrens
83 find_container a_finds; // fast access for message first-level avps
86 int a_insertionPositionForChilds; // used with childrens
87 anna::DataBlock a_forCode;
89 const Avp* _getAvp(const char *name, int ocurrence, anna::Exception::Mode::_v emode) const throw(anna::RuntimeException);
91 // --- Developer notes ---
92 // 'AVP Length' does not include posible data padding. Thanks to this, 'Data Length'
93 // is the difference between 'AVP Length' and sum of code, length, flags and
94 // optionally the vendor-ID (all of them are 32-bit boundary), that is to say:
95 // 8 or 12 (vendor-specific avps).
97 // Grouped avps 'AVP Length' includes own headers plus the total length of all
98 // underlying AVPs, including their headers and padding, then 'AVP Length' is
99 // always multiple of 4 (library will check this), and smae for 'Data Length'
100 // which is an 'whole avp Length with padding' itself.
106 avp_iterator avp_begin() throw() { return a_avps.begin(); }
107 avp_iterator avp_end() throw() { return a_avps.end(); }
108 const_avp_iterator avp_begin() const throw() { return a_avps.begin(); }
109 const_avp_iterator avp_end() const throw() { return a_avps.end(); }
112 * Gets avp total message length.
114 U24 getLength() const throw();
118 bool flagsOK(int &rc) const throw(); // flags coherence regarding dictionary. Only must be called when Message is identified at the dictionary.
119 int addChild(Avp *avp) throw() { return Avp::addChild(a_avps, a_insertionPositionForChilds, avp); }
120 const anna::diameter::stack::Command *getStackCommand(CommandId id) const throw(anna::RuntimeException);
122 void setFailedAvp(const parent_t &parent, AvpId wrong, const char *wrongName = NULL) throw(anna::RuntimeException);
123 // During message decoding and validation, the first wrong avp is stored and all the tracking is managed to find out its
124 // nested path for the case of grouped avps with wrong avps inside. Remember the RFC 6733, section 7.5:
126 // In the case where the offending AVP is embedded within a Grouped AVP,
127 // the Failed-AVP MAY contain the grouped AVP, which in turn contains
128 // the single offending AVP. The same method MAY be employed if the
129 // grouped AVP itself is embedded in yet another grouped AVP and so on.
130 // In this case, the Failed-AVP MAY contain the grouped AVP hierarchy up
131 // to the single offending AVP. This enables the recipient to detect
132 // the location of the offending AVP when embedded in a group.
134 // The first wrong avp found will set the final result code, as the RFC recommends:
136 // The value of the Result-Code AVP will provide information on the reason
137 // for the Failed-AVP AVP. A Diameter answer message SHOULD contain an
138 // instance of the Failed-AVP AVP that corresponds to the error
139 // indicated by the Result-Code AVP. For practical purposes, this
140 // Failed-AVP would typically refer to the first AVP processing error
141 // that a Diameter node encounters.
143 // The message keeps the list (reverse order) of avps hierarchy (in case of grouping) for the final Failed-AVP construction,
144 // which is done at the end of decoding or validation, and only the first wrong avp is stored with its corresponding path.
150 mutable Engine *a_engine;
152 /** Codec Engine getter: avoids have to create base engine when using its child */
153 virtual Engine * getEngine() const throw(anna::RuntimeException);
156 * Initializes Message class information.
157 * Any reimplementation must first invoke base class method.
159 virtual void initialize() throw();
165 * Default constructor
170 * Identified constructor
171 * @param id Command identifier as pair (code,request-indicator).
173 Message(CommandId id);
176 /** Sets the codec engine */
177 void setEngine(Engine *engine) throw() { a_engine = engine; }
181 static const int HeaderLength;
192 // T(Potentially re-transmitted message)
193 // r(eserved) - these flag bits are reserved for future use, and
194 // MUST be set to zero, and ignored by the receiver.
195 static const U8 RBitMask;
196 static const U8 PBitMask;
197 static const U8 EBitMask;
198 static const U8 TBitMask;
205 // Virtual destructors are useful when you can delete an instance of a derived class through a pointer to base class:
206 // This destructor is not virtual, then a pointer to base class (even pointing to a children one) will invoke this destructor, not the derived one.
207 // My current solution: virtualizing method 'clear'
210 // To sum up, always make base classes' destructors virtual when they're meant to be manipulated polymorphically.
215 Sets the command identifier and clear the former content.
217 @param id Command identifier as pair (code,request-indicator).
218 @param _clear Message will be cleared when updating the command identifier (default behaviour).
220 void setId(CommandId id, bool _clear = true) throw(anna::RuntimeException);
223 Same as #setId but providing dictionary logical name for Avp searched
225 void setId(const char *name) throw(anna::RuntimeException);
228 Sets the command version. By default, messages initializes with value 1.
230 @param version Version provided
232 void setVersion(U8 version) throw() { a_version = version; }
235 Sets/unsets P bit activation.
236 Application should not have to use this because dictionary information is used in order to configure flags when Message identifier is stored.
238 @param activate Activates/deactivates the bit. True by default.
240 void setProxiableBit(bool activate = true) throw() { if(activate) a_flags |= PBitMask; else a_flags &= (~PBitMask); }
243 Sets/unsets E bit activation.
244 Application should not have to use this because dictionary information is used in order to configure flags when Message identifier is stored.
246 @param activate Activates/deactivates the bit. True by default.
248 void setErrorBit(bool activate = true) throw() { if(activate) a_flags |= EBitMask; else a_flags &= (~EBitMask); }
251 Sets/unsets T bit activation.
252 Application should not have to use this because dictionary information is used in order to configure flags when Message identifier is stored.
254 @param activate Activates/deactivates the bit. True by default.
256 void setPotentiallyReTransmittedMessageBit(bool activate = true) throw() { if(activate) a_flags |= TBitMask; else a_flags &= (~TBitMask); }
259 Sets the message application id.
261 The codec engine could be configured to force a stack selection based in this field value: see #selectStackWithApplicationId.
262 In multistack applications (which also shall be monothreaded), you only have to take care about how to apply this method: the thing
263 is that you must not interleave message builds which belongs to different stacks. For example, you could think about setting the
264 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.
265 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
266 method). The result could be unexpected when adding/encoding messages with a dictionary which does not correspond.
268 @warning do not interleave build/encode operations between different messages which uses different stacks over the same codec engine.
269 It seems common sense, but it is not bad to advice about this.
271 @param aid Application-id.
273 void setApplicationId(U32 aid) throw();
276 Sets the message hop-by-hop
277 @param hbh Hop-by-hop identifier.
279 void setHopByHop(U32 hbh) throw() { a_hopByHop = hbh; }
282 Sets the message end-to-end
283 @param ete End-to-end identifier.
285 void setEndToEnd(U32 ete) throw() { a_endToEnd = ete; }
289 Sets header to be an answer regarding provided request message code.
290 Internally, updates command identifier (indeed request flag), promotes version, application identifier, hop-by-hop and end-to-end fields.
292 @param request Message to be answered.
294 @warning Request provided must be a request, in other case method do nothing.
296 void setHeaderToAnswer(const Message &request) throw() {
297 if(!request.getId().second) return;
299 setId(CommandId(request.getId().first, !request.getId().second), false /* don't clear */);
300 setVersion(request.getVersion());
301 setApplicationId(request.getApplicationId());
302 setHopByHop(request.getHopByHop()); // The same Hop-by-Hop Identifier in the request is used in the answer (RFC 6733 Section 6.2).
303 setEndToEnd(request.getEndToEnd()); // The same End-to-End Identifier in the request is used in the answer (RFC 6733 Section 6.2).
304 setProxiableBit(request.proxiableBit()); // The 'P' bit is set to the same value as the one in the request (RFC 6733 Section 6.2).
309 Standard minimum-answer building from requests. Adds Session-Id (mirrored from request if present), Origin-Host and Origin-Realm
310 (which could be configured, extracted from optional Destination AVPs, etc.), and all the Proxy-Info AVPs (added in same order as
311 appear on the request). Of course, answer message header is built from request information through #setHeaderToAnswer. Finally,
312 message is fixed regarding dictionary elements order (#fix).
314 Summing up, as RFC 6733 Section 6.2, says:
318 6.2. Diameter Answer Processing
320 When a request is locally processed, the following procedures MUST be
321 applied to create the associated answer, in addition to any
322 additional procedures that MAY be discussed in the Diameter
323 application defining the command:
325 o The same Hop-by-Hop Identifier in the request is used in the
328 o The local host's identity is encoded in the Origin-Host AVP.
330 o The Destination-Host and Destination-Realm AVPs MUST NOT be
331 present in the answer message.
333 o The Result-Code AVP is added with its value indicating success or
336 o If the Session-Id is present in the request, it MUST be included
339 o Any Proxy-Info AVPs in the request MUST be added to the answer
340 message, in the same order they were present in the request.
342 o The 'P' bit is set to the same value as the one in the request.
344 o The same End-to-End identifier in the request is used in the
347 Note that the error messages (see Section 7) are also subjected to
348 the above processing rules.
350 Regarding errors, is recommended to use this over automatic answer built at #decode and/or #valid procedures, which would had added
351 Result-Code and/or Failed-AVP AVPs if proceed, but be aware of DIAMETER_COMMAND_UNSUPPORTED Result-Code, because becomes impossible
352 to fix (Session-Id SHOULD appear immediately following the Diameter header, and #fix do this manually even if no information about
353 the command structure is known, but perhaps another fixed AVPs could not comply... use #getResultCode to find out this situation before
354 using #setStandardToAnswer). Anyway, application could add another Failed-AVP content no detected internally, for example:
355 DIAMETER_CONTRADICTING_AVPS or DIAMETER_INVALID_AVP_BIT_COMBO). Also, application could add more Failed-AVP avps with other
356 wrong avps, or accumulate wrong avps inside the one and only Failed-AVP managed by the stack. The standard is open to add multiple
357 avps inside Failed-AVP or multiple Failed-AVP avps with single or multiple avps inside. This depends on application criteria regarding
358 other nodes. However, internally the Anna::diameter stack only provides one Failed-AVP with the first wrong avp found, as RFC 6733 says
361 If application decoding and/or validation operations are ok, user may search for other problems and put the appropiate Result-Code.
362 For example, DIAMETER_TOO_BUSY (3004) depends on congestion issues at business layer and cannot be decided with the only message
363 information automatically (not all the Result-Code values are taken into account, only those which correspond to anomalies managed
364 by anna::diameter::codec). Application Result-Codes could be provided in this prototype, being DIAMETER_SUCCESS the default value if missing.
367 @param request Message to be answered.
368 @param originHost Mandatory Origin-Host diameter identity value provided by application. If answer has already an Origin-Host, this will be ignored.
369 @param originRealm Mandatory Origin-Realm diameter identity value provided by application. If answer has already an Origin-Realm, this will be ignored.
370 @param resultCode Result-Code value assigned by application. If non-success value is already assigned, this will be ignored. DIAMETER_SUCCESS is provided by default.
372 @warning Request provided must be a request, in other case method do nothing.
374 void setStandardToAnswer(const Message &request, const std::string &originHost, const std::string &originRealm, int resultCode = helpers::base::AVPVALUES__Result_Code::DIAMETER_SUCCESS) throw();
378 Sets a Result-Code AVP over an answer message (for requests, do nothing).
379 If Result-Code AVP doesn't exists, is added and then filled with the value provided.
380 If Result-Code AVP already exists, value detected is replaced if was DIAMETER_SUCCESS (non success codes are unchanged).
381 When provided value corresponds to an protocol error, that is to say within range [3001,3010], message (E)rror bit is
382 automatically activated.
384 This method is internally used during #decode and/or #valid procedures in order to build automatic answers, but application
385 could call this for set another Result-Code no detected by these methods within its category or for other one (application
386 layer). These are the Result-Codes implemented (detected) by ANNA::diameter::codec:
391 DIAMETER_COMMAND_UNSUPPORTED
392 DIAMETER_INVALID_HDR_BITS
393 DIAMETER_INVALID_AVP_BITS
397 DIAMETER_AVP_UNSUPPORTED (F)
398 DIAMETER_INVALID_AVP_VALUE (F)
399 DIAMETER_MISSING_AVP (F)
400 DIAMETER_AVP_NOT_ALLOWED (F)
401 DIAMETER_AVP_OCCURS_TOO_MANY_TIMES (F)
402 DIAMETER_INVALID_BIT_IN_HEADER
403 DIAMETER_INVALID_AVP_LENGTH (F)
404 DIAMETER_INVALID_MESSAGE_LENGTH
406 (F) Generates Failed-AVP (also DIAMETER_CONTRADICTING_AVPS and DIAMETER_INVALID_AVP_BIT_COMBO
407 values does, but these are not managed by anna::diameter::codec).
410 @param rc Result-Code value. DIAMETER_SUCCESS by default.
412 void setResultCode(int rc = helpers::base::AVPVALUES__Result_Code::DIAMETER_SUCCESS) throw(anna::RuntimeException);
416 Gets the Result-Code AVP value from an answer message (for requests, returns -1).
417 If missing, -1 value is returned.
419 @return Result-Code value for answers, -1 for request and answers without Result-Code AVP inside
421 int getResultCode() const throw();
425 Adds an avp child providing its identifier and reserve internal memory it.
427 @param id Avp identifier as pair (code,vendor-id).
429 @return Pointer to the new created avp.
431 Avp * addAvp(AvpId id) throw(anna::RuntimeException) { return Avp::addAvp(a_avps, a_insertionPositionForChilds, id, getEngine()); }
435 Same as #addAvp but providing dictionary logical name for Avp searched
437 Avp * addAvp(const char *name) throw(anna::RuntimeException);
441 Adds an avp child providing a persistent pointer (must be maintained by application).
443 @param avp Avp external pointer. If NULL provided, nothing is done and NULL returned.
445 @return Pointer to the added avp (again).
447 Avp * addAvp(Avp * avp) throw() { if(!avp) return NULL; addChild(avp); return avp; }
451 Removes an Avp within message (first level) and free resources.
453 @param id Avp identifier (pair code + vendor-id).
454 @param ocurrence Order of appearance for the searched avp. Zero value means remove all avps with provided identifier at first level (no recursiveness would be allowed in the API in order to avoid unexpected behaviour).
455 Negative values could be used to reverse access positions: i.e. -1 is the last ocurrence, -2 is the second to last (penultimate), etc.
457 @return Returns true if something was removed. False in other cases (including i.e. when this message is empty).
459 bool removeAvp(AvpId id, int ocurrence = 1) throw(anna::RuntimeException) { return Avp::removeAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine()); }
463 Same as #removeAvp but providing dictionary logical name for Avp searched
465 bool removeAvp(const char *name, int ocurrence = 1) throw(anna::RuntimeException);
469 * Clears and initializes Message class information.
470 * Application must clear auxiliary message objects before adding Avps in a new context.
471 * Application don't need to clear a message object before decode operation (decode invokes #clear before any other task).
472 * Any reimplementation must first invoke base class method.
474 virtual void clear() throw(anna::RuntimeException);
477 Decodes buffer provided over class content. If an error ocurred, decoding will stop launching exception (fatal error) or a warning trace (perhaps the achieved
478 message is valid against all odds then validation will go on). In case that validation is enabled (codec::Engine::ValidationMode) an exception will be launched
479 in a moment which depends on validation depth (codec::Engine::ValidationDepth).
481 @param db buffer data block processed. Before decoding, the whole message instance will be cleared (no need to invoke #clear before #decode).
482 @param ptrAnswer Answer set by application (could be empty or not), who is responsible for its memory reservation,
483 and automatically built regarding standard. If message analyzed realizes to be an answer, internal reference becomes
484 NULL because no answer is built for answers. By default, automatic answer is not built.
486 void decode(const anna::DataBlock &db, Message *ptrAnswer = NULL) throw(anna::RuntimeException);
489 Fix childrens content regarding dictionary avp positions.
490 Message could remain invalid because of possible fixed/mandatory avps.
491 This is useful to give flexibility to the application during message construction before encoding or representing the data.
492 Is not recommended to fix a recently decoded message because possible validation problems will be hidden.
497 Validates the message regarding dictionary rules like enumerated range, flags coherence, mandatory and fixed types, cardinality qualifiers, etc.
498 @return Boolean indicating validation result
499 @param ptrAnswer Answer set by application (could be empty or not), who is responsible for its memory reservation,
500 and automatically built regarding standard. If message analyzed realizes to be an answer, internal reference becomes
501 NULL because no answer is built for answers. By default, automatic answer is not built.
503 bool valid(Message *ptrAnswer = NULL) const throw(anna::RuntimeException);
507 Interpret xml data in order to dump over the class content.
508 \param messageNode Message root node
510 void fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeException);
513 Interpret xml string representation in order to dump over the class content.
514 DTD validation is used in the same way that #loadXML does.
515 \param xmlString XML string representation with relevant information for this instance
517 void fromXMLString(const std::string &xmlString) throw(anna::RuntimeException);
520 Loads an xml file based on this message DTD (could be accumulative, no initialization will be performed by this method).
523 <!ELEMENT message (avp*)>
524 <!ELEMENT avp (avp*)>
526 <!ATTLIST message version CDATA #IMPLIED name CDATA #IMPLIED code CDATA #IMPLIED flags CDATA #IMPLIED application-id CDATA #REQUIRED hop-by-hop-id CDATA #IMPLIED end-by-end-id CDATA #IMPLIED>
528 version: Diameter version. Sets '1' by default
529 name: Command name within working stack (dictionary identifier)
531 In order to get more coding capabilities, command code and flags could be established instead of former command name,
532 but neither of them are allowed if 'name' is provided (and vice versa):
535 flags: Command flags byte value (0-255) where standard bit set for flags is 'RPET rrrr': (R)equest, (P)roxiable, (E)rror, Potentially re-(T)ransmitted message and (r)eserved
538 application-id: Message application id
539 hop-by-hop-id: Message hop by hop id. Sets '0' by default
540 end-by-end-id: Message end by end id. Sets '0' by default
543 <!ATTLIST avp name CDATA #IMPLIED code CDATA #IMPLIED vendor-code CDATA #IMPLIED flags CDATA #IMPLIED data CDATA #IMPLIED hex-data CDATA #IMPLIED>
545 name: Avp name within working stack (dictionary identifier)
547 In order to get more coding capabilities, avp code, vendor-id and flags could be established instead of former avp name,
548 but neither of them are allowed if 'name' is provided (and vice versa):
551 vendor-code: Avp vendor code
552 flags: Avp flags byte value (0-255) where standard bit set for flags is 'VMPr rrrr': (V)endor-specific, (M)andatory, end to end encry(P)tion and r(eserved)
555 data: Natural string representation for avp data. Specially applicable with numbers and printable strings, but also
556 useful for certain formats which could be easily understandable in such friendly/smart representation. We will
557 achieve different human-readable strings depending on data format:
559 [ OctetString ] (if printable, but not recommended)
560 [ Integer32, Integer64, Unsigned32, Unsigned64, Float32, Float64 ] (normal number representation)
561 [ Time ] (NTP timestamp, normal number representation)
562 [ Address ] (auto detects IPv4 or IPv6 address version, then only ip address is specified: IPv4 with dots, IPv6 with colons)
563 [ UTF8String, DiameterIdentity, DiameterURI ] (printable)
564 [ IPFilterRule, QoSFilterRule ] (uses ASCII charset, printable)
566 New application formats must define specific natural representation for internal raw data
568 hex-data: Hexadecimal octet sequence representation (i.e. 'af012fb3', with even number of digits). Suitable for whatever kind
569 of diameter format, but mandatory for non printable information. OctetString usually transport non human-readable
570 data and should better be encoded within this field although being printable. Unknown avps (which fails identifying
571 provided name or code/vendor-code) must always use this representation.
573 Xml representation for decoded messages shows natural content except for 'OctetString' format and unknown avps. Anyway, when printable,
574 OctetString could show such information at data field apart from hex-data, because many implementations use this format to transport
575 readable-string data. In general, one of the data fields is mandatory except for 'Grouped' type (its data is another level of avps).
576 Application-specific formats must decide the way to represent its contents, being recommended to use a natural representation if possible,
577 because xml is read by humans with testing and monitoring purposes.
581 @param xmlPathFile Complete path file to the xml document which represents the diameter message
584 void loadXML(const std::string & xmlPathFile) throw(anna::RuntimeException);
591 Gets Message identifier as pair (code, request indicator).
593 const CommandId & getId() const throw() { return a_id; }
596 Gets the command version. By default, messages initializes with value 1.
598 @return version Message version
600 U8 getVersion() const throw() { return a_version; }
603 Gets Message request indicator.
605 bool isRequest() const throw() { return a_id.second; }
608 Gets Message answer indicator.
610 bool isAnswer() const throw() { return !isRequest(); }
613 Gets the message application id
614 @return aid Application-id.
616 const U32 & getApplicationId() const throw() { return a_applicationId; }
619 Gets the message hop-by-hop
620 @return hbh Hop-by-hop identifier.
622 const U32 & getHopByHop() const throw() { return a_hopByHop; }
625 Gets the message end-to-end
626 @return ete End-to-end identifier.
628 const U32 & getEndToEnd() const throw() { return a_endToEnd; }
631 Gets stack command (dictionary command reference).
633 const anna::diameter::stack::Command *getStackCommand() const throw(anna::RuntimeException) { return getStackCommand(a_id); }
635 /** Returns R bit activation state */
636 bool requestBit() const throw() { return ((a_flags & RBitMask) != 0x00); }
638 /** Returns P bit activation state */
639 bool proxiableBit() const throw() { return ((a_flags & PBitMask) != 0x00); }
641 /** Returns E bit activation state */
642 bool errorBit() const throw() { return ((a_flags & EBitMask) != 0x00); }
644 /** Returns T bit activation state */
645 bool potentiallyReTransmittedMessageBit() const throw() { return ((a_flags & TBitMask) != 0x00); }
649 Access content for internal Avps. Exception mode allows different combinations like cascade access:
653 message->getAvp(anna::diameter::helpers::base::AVP__Multiple_Services_Credit_Control, anna::Exception::Mode::Throw)
654 ->getAvp(anna::diameter::helpers::base::AVP__Rating_Group, anna::Exception::Mode::Throw);
656 catch(anna::RuntimeException) {;}
662 const Avp *mscc = message->getAvp(anna::diameter::helpers::base::AVP__Multiple_Services_Credit_Control);
664 if (mscc) rg = mscc->getAvp(anna::diameter::helpers::base::AVP__Rating_Group);
667 Replacing procedures becomes easy because an Avp can be searched and its pointer reconfigured by mean #setId and data part setters.
668 Deleting procedures must use #removeAvp.
669 Access is internally cached to speed up the search operations. This cache is reset after calling #fix or #removeAvp methods.
671 @param id Avp identifier (pair code + vendor-id).
672 @param ocurrence Order of appearance for the searched avp. Zero position is rejected, but negative values could be used to reverse
673 access positions: i.e. -1 is the last ocurrence, -2 is the second to last (penultimate), etc.
674 @param emode Excepcion mode handling: Ignore (no action is taken), Throw (excepcion when missing avp), Trace (trace situation as warning).
676 const Avp* getAvp(AvpId id, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) const throw(anna::RuntimeException) {
677 return Avp::getAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine(), emode);
680 Avp* getAvp(AvpId id, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException) {
681 return const_cast<Avp*>(Avp::getAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine(), emode));
686 Same as #getAvp but providing dictionary logical name for Avp searched
688 const Avp* getAvp(const char *name, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) const throw(anna::RuntimeException) {
689 return _getAvp(name, ocurrence, emode);
692 Avp* getAvp(const char *name, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException) {
693 return const_cast<Avp*>(_getAvp(name, ocurrence, emode));
699 Counts the number of ocurrences of Avps (first level) with the identifier provided
701 @param id Avp identifier (pair code + vendor-id).
703 int countAvp(AvpId id) const throw() { return Avp::countAvp(a_avps, id); }
706 Same as #countAvp but providing dictionary logical name for Avp searched
708 int countAvp(const char *name) const throw(anna::RuntimeException);
711 Counts the number of children
713 @param id Avp identifier (pair code + vendor-id).
715 int countChilds() const throw() { return Avp::countChilds(a_avps); }
718 Encodes datablock with the class content. In case that validation is enabled (codec::Engine::ValidationMode) an exception will be launched
719 in a moment which depends on validation depth (codec::Engine::ValidationDepth). If you want to see validation errors but go on with encoding,
720 you should try/catch #valid() procedure out of #code.
722 @return DataBlock encoded (internal memory used)
724 const anna::DataBlock & code() throw(anna::RuntimeException);
727 Class xml representation
728 \param parent Parent XML node on which hold this instance information.
729 \return XML document with relevant information for this instance.
731 anna::xml::Node* asXML(anna::xml::Node* parent) const throw();
734 Class xml string representation
735 \return XML string representation with relevant information for this instance.
737 std::string asXMLString() const throw();
740 Comparison operator by mean serialization
742 @param m1 Instance 1 for Message class
743 @param m2 Instance 2 for Message class
745 @return Comparison result
747 friend bool operator == (const Message & m1, const Message & m2) throw() { return (m1.asXMLString() == m2.asXMLString()); }
750 Match a regular expression (string pattern) regarding xml string serialization for this message.
751 Using a complex pattern (many avps, grouped ones) it could be necessary to fix the message before
752 using the method in order to perform a more controlled comparison. In the same way, flags could be
753 ignored to simplify message xml presentation.
754 This powerful tool could be used to program traffic analysis and decide future behaviour (routing,
760 The pattern '<avp name="Service-Context-Id" data="(.)*32251@3gpp.org"/>' detects PS charging contexts
761 because of data suffix specification '32251@3gpp.org' for that AVP.
763 The pattern '<message version="1" name="Capabilities-Exchange-Request"' detects a CER message.
765 The pattern (string including carriage returns):
767 '<avp name="Subscription-Id">
768 <avp name="Subscription-Id-Type" data="0" alias="END_USER_E164"/>
769 <avp name="Subscription-Id-Data" data="606000106"/>
772 detects MSISDN (not IMSI) equal to 606000106
774 It would seems strange or 'creative' to use regular expressions within an hex string representation,
775 but anyway you could also do such kind of things to check non-printable data parts within the message:
776 for example, the pattern '<avp name="Framed-IP-Address" hex-data="0a[A-Fa-f0-9][A-Fa-f0-9]0a0a"/>'
777 matchs IP addresses for '10.x.10.10' where x = [0..255].
779 Note that string pattern could also be generated via #loadXML and then #asXML, that is to say, you
780 could get patterns through xml files which act as conditional triggers over message. In that case,
781 it is not possible to specify regular expressions within xml 'hex-data' fields because parser will fail
782 during hexadecimal read. Normally only printable 'data' fields are used for matching issues.
784 For example, imagine a 'pattern.xml' file like:
785 <message version="1" name="Credit-Control-Request" application-id="16777236" hop-by-hop-id="0" end-by-end-id="0">
786 <avp name="Subscription-Id">
787 <avp name="Subscription-Id-Type" data="0" alias="END_USER_E164"/>
788 <avp name="Subscription-Id-Data" data="616[0-9]{6,6}"/>
794 anna::diameter::codec::Message patternMessage;
795 patternMessage.loadXML("pattern.xml");
796 std::string pattern = patternMessage.getAvp("Subscription-Id")->getAvp("Subscription-Id-Type")->asXMLString();
797 // Former is '<avp name="Subscription-Id-Data" data="616[0-9]{6,6}"/>'
798 bool match = incomingMessage.isLike(pattern);
800 Then, messages having MSISDN numbers starting with '616' will match the pattern.
801 Note, that any other message codes (and not only Credit-Control-Request ones), could pass the test...
802 You could also build that string manually:
805 std::string pattern = "<avp name=\"Subscription-Id\">\n";
806 pattern += ANNA_XML_COMPILER_TAB; pattern += "<avp name=\"Subscription-Id-Type\" data=\"0\" alias=\"END_USER_E164\"/>\n"
807 pattern += ANNA_XML_COMPILER_TAB; pattern += "<avp name=\"Subscription-Id-Data\" data=\"616[0-9]{6,6}\"/>"
810 std::string pattern = "name=\"Subscription-Id\"(.)*name=\"Subscription-Id-Type\" data=\"0\"(.)*name=\"Subscription-Id-Data\" data=\"616[0-9]{6,6}\"";
813 \return Returns the match result
815 bool isLike(const std::string &pattern) const throw();
818 //friend class Engine;