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
166 * @param engine Codec engine used
168 Message(Engine *engine = NULL);
171 * Identified constructor
172 * @param id Command identifier as pair (code,request-indicator).
173 * @param engine Codec engine used
175 Message(CommandId id, Engine *engine = NULL);
178 /** Sets the codec engine */
179 void setEngine(Engine *engine) throw() { a_engine = engine; }
183 static const int HeaderLength;
194 // T(Potentially re-transmitted message)
195 // r(eserved) - these flag bits are reserved for future use, and
196 // MUST be set to zero, and ignored by the receiver.
197 static const U8 RBitMask;
198 static const U8 PBitMask;
199 static const U8 EBitMask;
200 static const U8 TBitMask;
207 // Virtual destructors are useful when you can delete an instance of a derived class through a pointer to base class:
208 // 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.
209 // My current solution: virtualizing method 'clear'
212 // To sum up, always make base classes' destructors virtual when they're meant to be manipulated polymorphically.
217 Sets the command identifier and clear the former content.
219 @param id Command identifier as pair (code,request-indicator).
220 @param _clear Message will be cleared when updating the command identifier (default behaviour).
222 void setId(CommandId id, bool _clear = true) throw(anna::RuntimeException);
225 Same as #setId but providing dictionary logical name for Avp searched
227 void setId(const char *name) throw(anna::RuntimeException);
230 Sets the command version. By default, messages initializes with value 1.
232 @param version Version provided
234 void setVersion(U8 version) throw() { a_version = version; }
237 Sets/unsets P bit activation.
238 Application should not have to use this because dictionary information is used in order to configure flags when Message identifier is stored.
240 @param activate Activates/deactivates the bit. True by default.
242 void setProxiableBit(bool activate = true) throw() { if(activate) a_flags |= PBitMask; else a_flags &= (~PBitMask); }
245 Sets/unsets E bit activation.
246 Application should not have to use this because dictionary information is used in order to configure flags when Message identifier is stored.
247 This flag MUST NOT be set in request messages (in this case, it will be ignored).
249 @param activate Activates/deactivates the bit. True by default.
251 void setErrorBit(bool activate = true) throw() { if(isRequest()) return; if(activate) a_flags |= EBitMask; else a_flags &= (~EBitMask); }
254 Sets/unsets T bit activation.
255 Application should not have to use this because dictionary information is used in order to configure flags when Message identifier is stored.
256 This flag MUST NOT be set in answer messages (in this case, it will be ignored).
258 @param activate Activates/deactivates the bit. True by default.
260 void setPotentiallyReTransmittedMessageBit(bool activate = true) throw() { if(isAnswer()) return; if(activate) a_flags |= TBitMask; else a_flags &= (~TBitMask); }
263 Sets the message application id.
265 The codec engine could be configured to force a stack selection based in this field value: see #selectStackWithApplicationId.
266 In multistack applications (which also shall be monothreaded), you only have to take care about how to apply this method: the thing
267 is that you must not interleave message builds which belongs to different stacks. For example, you could think about setting the
268 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.
269 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
270 method). The result could be unexpected when adding/encoding messages with a dictionary which does not correspond.
272 @warning do not interleave build/encode operations between different messages which uses different stacks over the same codec engine.
273 It seems common sense, but it is not bad to advice about this.
275 @param aid Application-id.
277 void setApplicationId(U32 aid) throw(anna::RuntimeException);
280 Sets the message hop-by-hop
281 @param hbh Hop-by-hop identifier.
283 void setHopByHop(U32 hbh) throw() { a_hopByHop = hbh; }
286 Sets the message end-to-end
287 @param ete End-to-end identifier.
289 void setEndToEnd(U32 ete) throw() { a_endToEnd = ete; }
293 Sets header to be an answer regarding provided request message code.
294 Internally, updates command identifier (indeed request flag), promotes version, application identifier, hop-by-hop and end-to-end fields.
296 @param request Message to be answered.
298 @warning Request provided must be a request, in other case method do nothing.
300 void setHeaderToAnswer(const Message &request) throw() {
301 if(!request.getId().second) return;
303 setId(CommandId(request.getId().first, !request.getId().second), false /* don't clear */);
304 setVersion(request.getVersion());
305 setApplicationId(request.getApplicationId());
306 setHopByHop(request.getHopByHop()); // The same Hop-by-Hop Identifier in the request is used in the answer (RFC 6733 Section 6.2).
307 setEndToEnd(request.getEndToEnd()); // The same End-to-End Identifier in the request is used in the answer (RFC 6733 Section 6.2).
308 setProxiableBit(request.proxiableBit()); // The 'P' bit is set to the same value as the one in the request (RFC 6733 Section 6.2).
313 Standard minimum-answer building from requests. Adds Session-Id (mirrored from request if present), Origin-Host and Origin-Realm
314 (which could be configured, extracted from optional Destination AVPs, etc.), and all the Proxy-Info AVPs (added in same order as
315 appear on the request). Of course, answer message header is built from request information through #setHeaderToAnswer. Finally,
316 message is fixed regarding dictionary elements order (#fix).
318 Summing up, as RFC 6733 Section 6.2, says:
322 6.2. Diameter Answer Processing
324 When a request is locally processed, the following procedures MUST be
325 applied to create the associated answer, in addition to any
326 additional procedures that MAY be discussed in the Diameter
327 application defining the command:
329 o The same Hop-by-Hop Identifier in the request is used in the
332 o The local host's identity is encoded in the Origin-Host AVP.
334 o The Destination-Host and Destination-Realm AVPs MUST NOT be
335 present in the answer message.
337 o The Result-Code AVP is added with its value indicating success or
340 o If the Session-Id is present in the request, it MUST be included
343 o Any Proxy-Info AVPs in the request MUST be added to the answer
344 message, in the same order they were present in the request.
346 o The 'P' bit is set to the same value as the one in the request.
348 o The same End-to-End identifier in the request is used in the
351 Note that the error messages (see Section 7) are also subjected to
352 the above processing rules.
354 Regarding errors, is recommended to use this over automatic answer built at #decode and/or #valid procedures, which would had added
355 Result-Code and/or Failed-AVP AVPs if proceed, but be aware of DIAMETER_COMMAND_UNSUPPORTED Result-Code, because becomes impossible
356 to fix (Session-Id SHOULD appear immediately following the Diameter header, and #fix do this manually even if no information about
357 the command structure is known, but perhaps another fixed AVPs could not comply... use #getResultCode to find out this situation before
358 using #setStandardToAnswer). Anyway, application could add another Failed-AVP content no detected internally, for example:
359 DIAMETER_CONTRADICTING_AVPS or DIAMETER_INVALID_AVP_BIT_COMBO). Also, application could add more Failed-AVP avps with other
360 wrong avps, or accumulate wrong avps inside the one and only Failed-AVP managed by the stack. The standard is open to add multiple
361 avps inside Failed-AVP or multiple Failed-AVP avps with single or multiple avps inside. This depends on application criteria regarding
362 other nodes. However, internally the Anna::diameter stack only provides one Failed-AVP with the first wrong avp found, as RFC 6733 says
365 If application decoding and/or validation operations are ok, user may search for other problems and put the appropiate Result-Code.
366 For example, DIAMETER_TOO_BUSY (3004) depends on congestion issues at business layer and cannot be decided with the only message
367 information automatically (not all the Result-Code values are taken into account, only those which correspond to anomalies managed
368 by anna::diameter::codec). Application Result-Codes could be provided in this prototype, being DIAMETER_SUCCESS the default value if missing.
371 @param request Message to be answered.
372 @param originHost Mandatory Origin-Host diameter identity value provided by application. If answer has already an Origin-Host, this will be ignored.
373 @param originRealm Mandatory Origin-Realm diameter identity value provided by application. If answer has already an Origin-Realm, this will be ignored.
374 @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.
376 @warning Request provided must be a request, in other case method do nothing.
378 void setStandardToAnswer(const Message &request, const std::string &originHost, const std::string &originRealm, int resultCode = helpers::base::AVPVALUES__Result_Code::DIAMETER_SUCCESS) throw();
382 Sets a Result-Code AVP over an answer message (for requests, do nothing).
383 If Result-Code AVP doesn't exists, is added and then filled with the value provided.
384 If Result-Code AVP already exists, value detected is replaced if was DIAMETER_SUCCESS (non success codes are unchanged).
385 When provided value corresponds to an protocol error, that is to say within range [3001,3010], message (E)rror bit is
386 automatically activated.
388 This method is internally used during #decode and/or #valid procedures in order to build automatic answers, but application
389 could call this for set another Result-Code no detected by these methods within its category or for other one (application
390 layer). These are the Result-Codes implemented (detected) by ANNA::diameter::codec:
395 DIAMETER_COMMAND_UNSUPPORTED
396 DIAMETER_INVALID_HDR_BITS
397 DIAMETER_INVALID_AVP_BITS
401 DIAMETER_AVP_UNSUPPORTED (F)
402 DIAMETER_INVALID_AVP_VALUE (F)
403 DIAMETER_MISSING_AVP (F)
404 DIAMETER_AVP_NOT_ALLOWED (F)
405 DIAMETER_AVP_OCCURS_TOO_MANY_TIMES (F)
406 DIAMETER_INVALID_BIT_IN_HEADER
407 DIAMETER_INVALID_AVP_LENGTH (F)
408 DIAMETER_INVALID_MESSAGE_LENGTH
410 (F) Generates Failed-AVP (also DIAMETER_CONTRADICTING_AVPS and DIAMETER_INVALID_AVP_BIT_COMBO
411 values does, but these are not managed by anna::diameter::codec).
414 @param rc Result-Code value. DIAMETER_SUCCESS by default.
416 void setResultCode(int rc = helpers::base::AVPVALUES__Result_Code::DIAMETER_SUCCESS) throw(anna::RuntimeException);
420 Gets the Result-Code AVP value from an answer message (for requests, returns -1).
421 If missing, -1 value is returned.
423 @return Result-Code value for answers, -1 for request and answers without Result-Code AVP inside
425 int getResultCode() const throw();
429 Adds an avp child providing its identifier and reserve internal memory it.
431 @param id Avp identifier as pair (code,vendor-id).
433 @return Pointer to the new created avp.
435 Avp * addAvp(AvpId id) throw(anna::RuntimeException) { return Avp::addAvp(a_avps, a_insertionPositionForChilds, id, getEngine()); }
439 Same as #addAvp but providing dictionary logical name for Avp searched
441 Avp * addAvp(const char *name) throw(anna::RuntimeException);
445 Adds an avp child providing a persistent pointer (must be maintained by application).
447 @param avp Avp external pointer. If NULL provided, nothing is done and NULL returned.
449 @return Pointer to the added avp (again).
451 Avp * addAvp(Avp * avp) throw() { if(!avp) return NULL; addChild(avp); return avp; }
455 Removes an Avp within message (first level) and free resources.
457 @param id Avp identifier (pair code + vendor-id).
458 @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).
459 Negative values could be used to reverse access positions: i.e. -1 is the last ocurrence, -2 is the second to last (penultimate), etc.
461 @return Returns true if something was removed. False in other cases (including i.e. when this message is empty).
463 bool removeAvp(AvpId id, int ocurrence = 1) throw(anna::RuntimeException) { return Avp::removeAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine()); }
467 Same as #removeAvp but providing dictionary logical name for Avp searched
469 bool removeAvp(const char *name, int ocurrence = 1) throw(anna::RuntimeException);
473 * Clears and initializes Message class information.
474 * Application must clear auxiliary message objects before adding Avps in a new context.
475 * Application don't need to clear a message object before decode operation (decode invokes #clear before any other task).
476 * Any reimplementation must first invoke base class method.
478 virtual void clear() throw(anna::RuntimeException);
481 Decodes buffer provided over class content. If an error ocurred, decoding will stop launching exception (fatal error) or a warning trace (perhaps the achieved
482 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
483 in a moment which depends on validation depth (codec::Engine::ValidationDepth).
485 @param db buffer data block processed. Before decoding, the whole message instance will be cleared (no need to invoke #clear before #decode).
486 @param ptrAnswer Answer set by application (could be empty or not), who is responsible for its memory reservation,
487 and automatically built regarding standard. If message analyzed realizes to be an answer, internal reference becomes
488 NULL because no answer is built for answers. By default, automatic answer is not built.
490 void decode(const anna::DataBlock &db, Message *ptrAnswer = NULL) throw(anna::RuntimeException);
493 Fix childrens content regarding dictionary avp positions.
494 Message could remain invalid because of possible fixed/mandatory avps.
495 This is useful to give flexibility to the application during message construction before encoding or representing the data.
496 Is not recommended to fix a recently decoded message because possible validation problems will be hidden.
501 Validates the message regarding dictionary rules like enumerated range, flags coherence, mandatory and fixed types, cardinality qualifiers, etc.
502 @return Boolean indicating validation result
503 @param ptrAnswer Answer set by application (could be empty or not), who is responsible for its memory reservation,
504 and automatically built regarding standard. If message analyzed realizes to be an answer, internal reference becomes
505 NULL because no answer is built for answers. By default, automatic answer is not built.
507 bool valid(Message *ptrAnswer = NULL) const throw(anna::RuntimeException);
511 Interpret xml data in order to dump over the class content.
512 \param messageNode Message root node
514 void fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeException);
517 Interpret xml string representation in order to dump over the class content.
518 DTD validation is used in the same way that #loadXML does.
519 \param xmlString XML string representation with relevant information for this instance
521 void fromXMLString(const std::string &xmlString) throw(anna::RuntimeException);
524 Loads an xml file based on this message DTD (could be accumulative, no initialization will be performed by this method).
527 <!ELEMENT message (avp*)>
528 <!ELEMENT avp (avp*)>
530 <!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>
532 version: Diameter version. Sets '1' by default
533 name: Command name within working stack (dictionary identifier)
535 In order to get more coding capabilities, command code and flags could be established instead of former command name,
536 but neither of them are allowed if 'name' is provided (and vice versa):
539 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
542 application-id: Message application id
543 hop-by-hop-id: Message hop by hop id. Sets '0' by default
544 end-by-end-id: Message end by end id. Sets '0' by default
547 <!ATTLIST avp name CDATA #IMPLIED code CDATA #IMPLIED vendor-code CDATA #IMPLIED flags CDATA #IMPLIED data CDATA #IMPLIED hex-data CDATA #IMPLIED>
549 name: Avp name within working stack (dictionary identifier)
551 In order to get more coding capabilities, avp code, vendor-id and flags could be established instead of former avp name,
552 but neither of them are allowed if 'name' is provided (and vice versa):
555 vendor-code: Avp vendor code
556 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)
559 data: Natural string representation for avp data. Specially applicable with numbers and printable strings, but also
560 useful for certain formats which could be easily understandable in such friendly/smart representation. We will
561 achieve different human-readable strings depending on data format:
563 [ OctetString ] (if printable, but not recommended)
564 [ Integer32, Integer64, Unsigned32, Unsigned64, Float32, Float64 ] (normal number representation)
565 [ Time ] (NTP timestamp, normal number representation)
566 [ Address ] (auto detects IPv4 or IPv6 address version, then only ip address is specified: IPv4 with dots, IPv6 with colons)
567 [ UTF8String, DiameterIdentity, DiameterURI ] (printable)
568 [ IPFilterRule, QoSFilterRule ] (uses ASCII charset, printable)
570 New application formats must define specific natural representation for internal raw data
572 hex-data: Hexadecimal octet sequence representation (i.e. 'af012fb3', with even number of digits). Suitable for whatever kind
573 of diameter format, but mandatory for non printable information. OctetString usually transport non human-readable
574 data and should better be encoded within this field although being printable. Unknown avps (which fails identifying
575 provided name or code/vendor-code) must always use this representation.
577 Xml representation for decoded messages shows natural content except for 'OctetString' format and unknown avps. Anyway, when printable,
578 OctetString could show such information at data field apart from hex-data, because many implementations use this format to transport
579 readable-string data. In general, one of the data fields is mandatory except for 'Grouped' type (its data is another level of avps).
580 Application-specific formats must decide the way to represent its contents, being recommended to use a natural representation if possible,
581 because xml is read by humans with testing and monitoring purposes.
585 @param xmlPathFile Complete path file to the xml document which represents the diameter message
588 void loadXML(const std::string & xmlPathFile) throw(anna::RuntimeException);
595 Gets Message identifier as pair (code, request indicator).
597 const CommandId & getId() const throw() { return a_id; }
600 Gets the command version. By default, messages initializes with value 1.
602 @return version Message version
604 U8 getVersion() const throw() { return a_version; }
607 Gets Message request indicator.
609 bool isRequest() const throw() { return a_id.second; }
612 Gets Message answer indicator.
614 bool isAnswer() const throw() { return !isRequest(); }
617 Gets the message application id
618 @return aid Application-id.
620 const U32 & getApplicationId() const throw() { return a_applicationId; }
623 Gets the message hop-by-hop
624 @return hbh Hop-by-hop identifier.
626 const U32 & getHopByHop() const throw() { return a_hopByHop; }
629 Gets the message end-to-end
630 @return ete End-to-end identifier.
632 const U32 & getEndToEnd() const throw() { return a_endToEnd; }
635 Gets stack command (dictionary command reference).
637 const anna::diameter::stack::Command *getStackCommand() const throw(anna::RuntimeException) { return getStackCommand(a_id); }
639 /** Returns R bit activation state */
640 bool requestBit() const throw() { return ((a_flags & RBitMask) != 0x00); }
642 /** Returns P bit activation state */
643 bool proxiableBit() const throw() { return ((a_flags & PBitMask) != 0x00); }
645 /** Returns E bit activation state */
646 bool errorBit() const throw() { return ((a_flags & EBitMask) != 0x00); }
648 /** Returns T bit activation state */
649 bool potentiallyReTransmittedMessageBit() const throw() { return ((a_flags & TBitMask) != 0x00); }
653 Access content for internal Avps. Exception mode allows different combinations like cascade access:
657 message->getAvp(anna::diameter::helpers::base::AVP__Multiple_Services_Credit_Control, anna::Exception::Mode::Throw)
658 ->getAvp(anna::diameter::helpers::base::AVP__Rating_Group, anna::Exception::Mode::Throw);
660 catch(anna::RuntimeException) {;}
666 const Avp *mscc = message->getAvp(anna::diameter::helpers::base::AVP__Multiple_Services_Credit_Control);
668 if (mscc) rg = mscc->getAvp(anna::diameter::helpers::base::AVP__Rating_Group);
671 Replacing procedures becomes easy because an Avp can be searched and its pointer reconfigured by mean #setId and data part setters.
672 Deleting procedures must use #removeAvp.
673 Access is internally cached to speed up the search operations. This cache is reset after calling #fix or #removeAvp methods.
675 @param id Avp identifier (pair code + vendor-id).
676 @param ocurrence Order of appearance for the searched avp. Zero position is rejected, but negative values could be used to reverse
677 access positions: i.e. -1 is the last ocurrence, -2 is the second to last (penultimate), etc.
678 @param emode Excepcion mode handling: Ignore (no action is taken), Throw (excepcion when missing avp), Trace (trace situation as warning).
680 const Avp* getAvp(AvpId id, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) const throw(anna::RuntimeException) {
681 return Avp::getAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine(), emode);
684 Avp* getAvp(AvpId id, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException) {
685 return const_cast<Avp*>(Avp::getAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine(), emode));
690 Same as #getAvp but providing dictionary logical name for Avp searched
692 const Avp* getAvp(const char *name, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) const throw(anna::RuntimeException) {
693 return _getAvp(name, ocurrence, emode);
696 Avp* getAvp(const char *name, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException) {
697 return const_cast<Avp*>(_getAvp(name, ocurrence, emode));
703 Counts the number of ocurrences of Avps (first level) with the identifier provided
705 @param id Avp identifier (pair code + vendor-id).
707 int countAvp(AvpId id) const throw() { return Avp::countAvp(a_avps, id); }
710 Same as #countAvp but providing dictionary logical name for Avp searched
712 int countAvp(const char *name) const throw(anna::RuntimeException);
715 Counts the number of children
717 @param id Avp identifier (pair code + vendor-id).
719 int countChilds() const throw() { return Avp::countChilds(a_avps); }
722 Encodes datablock with the class content. In case that validation is enabled (codec::Engine::ValidationMode) an exception will be launched
723 in a moment which depends on validation depth (codec::Engine::ValidationDepth). If you want to see validation errors but go on with encoding,
724 you should try/catch #valid() procedure out of #code.
726 @return DataBlock encoded (internal memory used)
728 const anna::DataBlock & code() throw(anna::RuntimeException);
731 Class xml representation
732 \param parent Parent XML node on which hold this instance information.
733 \return XML document with relevant information for this instance.
735 anna::xml::Node* asXML(anna::xml::Node* parent) const throw();
738 Class xml string representation
739 \return XML string representation with relevant information for this instance.
741 std::string asXMLString() const throw();
744 Comparison operator by mean serialization
746 @param m1 Instance 1 for Message class
747 @param m2 Instance 2 for Message class
749 @return Comparison result
751 friend bool operator == (const Message & m1, const Message & m2) throw() { return (m1.asXMLString() == m2.asXMLString()); }
754 Match a regular expression (string pattern) regarding xml string serialization for this message.
755 Using a complex pattern (many avps, grouped ones) it could be necessary to fix the message before
756 using the method in order to perform a more controlled comparison. In the same way, flags could be
757 ignored to simplify message xml presentation.
758 This powerful tool could be used to program traffic analysis and decide future behaviour (routing,
764 The pattern '<avp name="Service-Context-Id" data="(.)*32251@3gpp.org"/>' detects PS charging contexts
765 because of data suffix specification '32251@3gpp.org' for that AVP.
767 The pattern '<message version="1" name="Capabilities-Exchange-Request"' detects a CER message.
769 The pattern (string including carriage returns):
771 '<avp name="Subscription-Id">
772 <avp name="Subscription-Id-Type" data="0" alias="END_USER_E164"/>
773 <avp name="Subscription-Id-Data" data="606000106"/>
776 detects MSISDN (not IMSI) equal to 606000106
778 It would seems strange or 'creative' to use regular expressions within an hex string representation,
779 but anyway you could also do such kind of things to check non-printable data parts within the message:
780 for example, the pattern '<avp name="Framed-IP-Address" hex-data="0a[A-Fa-f0-9][A-Fa-f0-9]0a0a"/>'
781 matchs IP addresses for '10.x.10.10' where x = [0..255].
783 Note that string pattern could also be generated via #loadXML and then #asXML, that is to say, you
784 could get patterns through xml files which act as conditional triggers over message. In that case,
785 it is not possible to specify regular expressions within xml 'hex-data' fields because parser will fail
786 during hexadecimal read. Normally only printable 'data' fields are used for matching issues.
788 For example, imagine a 'pattern.xml' file like:
789 <message version="1" name="Credit-Control-Request" application-id="16777236" hop-by-hop-id="0" end-by-end-id="0">
790 <avp name="Subscription-Id">
791 <avp name="Subscription-Id-Type" data="0" alias="END_USER_E164"/>
792 <avp name="Subscription-Id-Data" data="616[0-9]{6,6}"/>
798 anna::diameter::codec::Message patternMessage;
799 patternMessage.loadXML("pattern.xml");
800 std::string pattern = patternMessage.getAvp("Subscription-Id")->getAvp("Subscription-Id-Type")->asXMLString();
801 // Former is '<avp name="Subscription-Id-Data" data="616[0-9]{6,6}"/>'
802 bool match = incomingMessage.isLike(pattern);
804 Then, messages having MSISDN numbers starting with '616' will match the pattern.
805 Note, that any other message codes (and not only Credit-Control-Request ones), could pass the test...
806 You could also build that string manually:
809 std::string pattern = "<avp name=\"Subscription-Id\">\n";
810 pattern += ANNA_XML_COMPILER_TAB; pattern += "<avp name=\"Subscription-Id-Type\" data=\"0\" alias=\"END_USER_E164\"/>\n"
811 pattern += ANNA_XML_COMPILER_TAB; pattern += "<avp name=\"Subscription-Id-Data\" data=\"616[0-9]{6,6}\"/>"
814 std::string pattern = "name=\"Subscription-Id\"(.)*name=\"Subscription-Id-Type\" data=\"0\"(.)*name=\"Subscription-Id-Data\" data=\"616[0-9]{6,6}\"";
817 \return Returns the match result
819 bool isLike(const std::string &pattern) const throw();
822 //friend class Engine;