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);
179 * Sets the codec engine.
181 * Once assigned (here or at constructor), this method SHALL NOT be used anymore.
182 * Also, the associated dictionary SHOULD NOT BE CHANGED through the engine,
183 * unless you know what are you doing. If you want to reconfigure the engine,
184 * first #clear the message and then you could reuse the same object with
185 * different configurations (execution contexts).
187 * Setting a new different engine with different stack, even same engine where the
188 * stack has been dynamically changed, could cause a bad behaviour depending on the
189 * changes: in general, if the dictionary grows, nothing bad will happen, but if
190 * you remove or modified some elements which were processed with a certain format,
191 * will be interpreted as 'unknown' with the new dictionary, and then some problems
192 * may occur. If you add elements (vendors, avps, messages) is not a problem.
194 void setEngine(Engine *engine) throw();
198 static const int HeaderLength;
209 // T(Potentially re-transmitted message)
210 // r(eserved) - these flag bits are reserved for future use, and
211 // MUST be set to zero, and ignored by the receiver.
212 static const U8 RBitMask;
213 static const U8 PBitMask;
214 static const U8 EBitMask;
215 static const U8 TBitMask;
222 // Virtual destructors are useful when you can delete an instance of a derived class through a pointer to base class:
223 // 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.
224 // My current solution: virtualizing method 'clear'
227 // To sum up, always make base classes' destructors virtual when they're meant to be manipulated polymorphically.
232 Sets the command identifier and clear the former content.
234 @param id Command identifier as pair (code,request-indicator).
236 void setId(CommandId id) throw(anna::RuntimeException);
239 Same as #setId but providing dictionary logical name for Avp searched
241 void setId(const char *name) throw(anna::RuntimeException);
244 Sets the command version. By default, messages initializes with value 1.
246 @param version Version provided
248 void setVersion(U8 version) throw() { a_version = version; }
251 Sets/unsets P 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 setProxiableBit(bool activate = true) throw() { if(activate) a_flags |= PBitMask; else a_flags &= (~PBitMask); }
259 Sets/unsets E bit activation.
260 Application should not have to use this because dictionary information is used in order to configure flags when Message identifier is stored.
261 This flag MUST NOT be set in request messages (in this case, it will be ignored).
263 @param activate Activates/deactivates the bit. True by default.
265 void setErrorBit(bool activate = true) throw() { if(isRequest()) return; if(activate) a_flags |= EBitMask; else a_flags &= (~EBitMask); }
268 Sets/unsets T bit activation.
269 Application should not have to use this because dictionary information is used in order to configure flags when Message identifier is stored.
270 This flag MUST NOT be set in answer messages (in this case, it will be ignored).
272 @param activate Activates/deactivates the bit. True by default.
274 void setPotentiallyReTransmittedMessageBit(bool activate = true) throw() { if(isAnswer()) return; if(activate) a_flags |= TBitMask; else a_flags &= (~TBitMask); }
277 Sets the message application id.
279 The codec engine could be configured to force a stack selection based in this field value: see #selectStackWithApplicationId.
280 In multistack applications (in case of being monothread), you only have to take care about how to apply this method: the thing
281 is that you must not interleave message builds which belongs to different stacks. For example, you could think about setting the
282 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.
283 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
284 method). The result could be unexpected when adding/encoding messages with a dictionary which does not correspond.
286 @warning do not interleave build/encode operations between different messages which uses different stacks over the same codec engine.
287 It seems common sense, but it is not bad to advice about this.
289 @param aid Application-id.
291 void setApplicationId(U32 aid) throw(anna::RuntimeException);
294 Sets the message hop-by-hop
295 @param hbh Hop-by-hop identifier.
297 void setHopByHop(U32 hbh) throw() { a_hopByHop = hbh; }
300 Sets the message end-to-end
301 @param ete End-to-end identifier.
303 void setEndToEnd(U32 ete) throw() { a_endToEnd = ete; }
307 Sets header to be an answer regarding provided request message code.
308 Internally, updates command identifier (indeed request flag), promotes version, application identifier, hop-by-hop and end-to-end fields.
310 @param request Message to be answered.
312 @warning Request provided must be a request, in other case method do nothing.
314 void setHeaderToAnswer(const Message &request) throw(anna::RuntimeException) {
315 if(!request.getId().second) return;
317 a_engine = request.getEngine(); // we know this will be
319 setId(CommandId(request.getId().first, !request.getId().second));
320 setVersion(request.getVersion());
321 setApplicationId(request.getApplicationId());
322 setHopByHop(request.getHopByHop()); // The same Hop-by-Hop Identifier in the request is used in the answer (RFC 6733 Section 6.2).
323 setEndToEnd(request.getEndToEnd()); // The same End-to-End Identifier in the request is used in the answer (RFC 6733 Section 6.2).
324 setProxiableBit(request.proxiableBit()); // The 'P' bit is set to the same value as the one in the request (RFC 6733 Section 6.2).
329 Standard minimum-answer building from requests. Adds Session-Id (mirrored from request if present), Origin-Host and Origin-Realm
330 (which could be configured, extracted from optional Destination AVPs, etc.), and all the Proxy-Info AVPs (added in same order as
331 appear on the request). Of course, answer message header is built from request information through #setHeaderToAnswer. Finally,
332 message is fixed regarding dictionary elements order (#fix).
334 Summing up, as RFC 6733 Section 6.2, says:
338 6.2. Diameter Answer Processing
340 When a request is locally processed, the following procedures MUST be
341 applied to create the associated answer, in addition to any
342 additional procedures that MAY be discussed in the Diameter
343 application defining the command:
345 o The same Hop-by-Hop Identifier in the request is used in the
348 o The local host's identity is encoded in the Origin-Host AVP.
350 o The Destination-Host and Destination-Realm AVPs MUST NOT be
351 present in the answer message.
353 o The Result-Code AVP is added with its value indicating success or
356 o If the Session-Id is present in the request, it MUST be included
359 o Any Proxy-Info AVPs in the request MUST be added to the answer
360 message, in the same order they were present in the request.
362 o The 'P' bit is set to the same value as the one in the request.
364 o The same End-to-End identifier in the request is used in the
367 Note that the error messages (see Section 7) are also subjected to
368 the above processing rules.
370 Regarding errors, is recommended to use this over automatic answer built at #decode and/or #valid procedures, which would had added
371 Result-Code and/or Failed-AVP AVPs if proceed, but be aware of DIAMETER_COMMAND_UNSUPPORTED Result-Code, because becomes impossible
372 to fix (Session-Id SHOULD appear immediately following the Diameter header, and #fix do this manually even if no information about
373 the command structure is known, but perhaps another fixed AVPs could not comply... use #getResultCode to find out this situation before
374 using #setStandardToAnswer). Anyway, application could add another Failed-AVP content no detected internally, for example:
375 DIAMETER_CONTRADICTING_AVPS or DIAMETER_INVALID_AVP_BIT_COMBO). Also, application could add more Failed-AVP avps with other
376 wrong avps, or accumulate wrong avps inside the one and only Failed-AVP managed by the stack. The standard is open to add multiple
377 avps inside Failed-AVP or multiple Failed-AVP avps with single or multiple avps inside. This depends on application criteria regarding
378 other nodes. However, internally the Anna::diameter stack only provides one Failed-AVP with the first wrong avp found, as RFC 6733 says
381 If application decoding and/or validation operations are ok, user may search for other problems and put the appropiate Result-Code.
382 For example, DIAMETER_TOO_BUSY (3004) depends on congestion issues at business layer and cannot be decided with the only message
383 information automatically (not all the Result-Code values are taken into account, only those which correspond to anomalies managed
384 by anna::diameter::codec). Application Result-Codes could be provided in this prototype, being DIAMETER_SUCCESS the default value if missing.
387 @param request Message to be answered.
388 @param originHost Mandatory Origin-Host diameter identity value provided by application. If answer has already an Origin-Host, this will be ignored.
389 @param originRealm Mandatory Origin-Realm diameter identity value provided by application. If answer has already an Origin-Realm, this will be ignored.
390 @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.
392 @warning Request provided must be a request, in other case method do nothing.
394 void setStandardToAnswer(const Message &request, const std::string &originHost, const std::string &originRealm, int resultCode = helpers::base::AVPVALUES__Result_Code::DIAMETER_SUCCESS) throw(anna::RuntimeException);
398 Sets a Result-Code AVP over an answer message (for requests, do nothing).
399 If Result-Code AVP doesn't exists, is added and then filled with the value provided.
400 If Result-Code AVP already exists, value detected is replaced if was DIAMETER_SUCCESS (non success codes are unchanged).
401 When provided value corresponds to an protocol error, that is to say within range [3001,3010], message (E)rror bit is
402 automatically activated.
404 This method is internally used during #decode and/or #valid procedures in order to build automatic answers, but application
405 could call this for set another Result-Code no detected by these methods within its category or for other one (application
406 layer). These are the Result-Codes implemented (detected) by ANNA::diameter::codec:
411 DIAMETER_COMMAND_UNSUPPORTED
412 DIAMETER_INVALID_HDR_BITS
413 DIAMETER_INVALID_AVP_BITS
417 DIAMETER_AVP_UNSUPPORTED (F)
418 DIAMETER_INVALID_AVP_VALUE (F)
419 DIAMETER_MISSING_AVP (F)
420 DIAMETER_AVP_NOT_ALLOWED (F)
421 DIAMETER_AVP_OCCURS_TOO_MANY_TIMES (F)
422 DIAMETER_INVALID_BIT_IN_HEADER
423 DIAMETER_INVALID_AVP_LENGTH (F)
424 DIAMETER_INVALID_MESSAGE_LENGTH
426 (F) Generates Failed-AVP (also DIAMETER_CONTRADICTING_AVPS and DIAMETER_INVALID_AVP_BIT_COMBO
427 values does, but these are not managed by anna::diameter::codec).
430 @param rc Result-Code value. DIAMETER_SUCCESS by default.
432 void setResultCode(int rc = helpers::base::AVPVALUES__Result_Code::DIAMETER_SUCCESS) throw(anna::RuntimeException);
436 Gets the Result-Code AVP value from an answer message (for requests, returns -1).
437 If missing, -1 value is returned.
439 @return Result-Code value for answers, -1 for request and answers without Result-Code AVP inside
441 int getResultCode() const throw();
445 Adds an avp child providing its identifier and reserve internal memory it.
447 @param id Avp identifier as pair (code,vendor-id).
449 @return Pointer to the new created avp.
451 Avp * addAvp(AvpId id) throw(anna::RuntimeException) { return Avp::addAvp(a_avps, a_insertionPositionForChilds, id, getEngine()); }
455 Same as #addAvp but providing dictionary logical name for Avp searched
457 Avp * addAvp(const char *name) throw(anna::RuntimeException);
461 Adds an avp child providing a persistent pointer (must be maintained by application).
462 It is not allowed to add an avp with no codec engine configured, neither if the engine
465 @param avp Avp external pointer. If NULL provided, nothing is done and NULL returned.
466 Also NULL returned for bad engine configuration.
468 @return Pointer to the added avp (again).
470 Avp * addAvp(Avp * avp) throw();
474 Removes an Avp within message (first level) and free resources.
476 @param id Avp identifier (pair code + vendor-id).
477 @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).
478 Negative values could be used to reverse access positions: i.e. -1 is the last ocurrence, -2 is the second to last (penultimate), etc.
480 @return Returns true if something was removed. False in other cases (including i.e. when this message is empty).
482 bool removeAvp(AvpId id, int ocurrence = 1) throw(anna::RuntimeException) { return Avp::removeAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine()); }
486 Same as #removeAvp but providing dictionary logical name for Avp searched
488 bool removeAvp(const char *name, int ocurrence = 1) throw(anna::RuntimeException);
492 * Clears and initializes Message class information.
493 * Application must clear auxiliary message objects before adding Avps in a new context if the same object is reused.
494 * Application don't need to clear a message object before decode operation (decode invokes #clear before any other task).
495 * Any reimplementation must first invoke base class method.
497 virtual void clear() throw(anna::RuntimeException);
500 Decodes buffer provided over class content. If an error ocurred, decoding will stop launching exception (fatal error) or a warning trace (perhaps the achieved
501 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
502 in a moment which depends on validation depth (codec::Engine::ValidationDepth).
504 @param db buffer data block processed. Before decoding, the whole message instance will be cleared (no need to invoke #clear before #decode).
505 @param ptrAnswer Answer set by application (could be empty or not), who is responsible for its memory reservation,
506 and automatically built regarding standard. If message analyzed realizes to be an answer, internal reference becomes
507 NULL because no answer is built for answers. By default, automatic answer is not built.
509 void decode(const anna::DataBlock &db, Message *ptrAnswer = NULL) throw(anna::RuntimeException);
512 Fix childrens content regarding dictionary avp positions.
513 Message could remain invalid because of possible fixed/mandatory avps.
514 This is useful to give flexibility to the application during message construction before encoding or representing the data.
515 Is not recommended to fix a recently decoded message because possible validation problems will be hidden.
520 Validates the message regarding dictionary rules like enumerated range, flags coherence, mandatory and fixed types, cardinality qualifiers, etc.
521 @return Boolean indicating validation result
522 @param ptrAnswer Answer set by application (could be empty or not), who is responsible for its memory reservation,
523 and automatically built regarding standard. If message analyzed realizes to be an answer, internal reference becomes
524 NULL because no answer is built for answers. By default, automatic answer is not built.
526 bool valid(Message *ptrAnswer = NULL) const throw(anna::RuntimeException);
529 Interpret xml data in order to dump over the class content.
530 \param messageNode Message root node obtained from @functions::xmlFileTo
532 void fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeException);
535 * Interpret a xml file in order to create a diameter message
537 * @see functions::messageXmlDocumentFromXmlFile
540 * @param xmlPathFile Complete path file to the xml document which represents the diameter message
542 void loadXML(const std::string &xmlPathFile) throw(anna::RuntimeException);
548 Gets Message identifier as pair (code, request indicator).
550 const CommandId & getId() const throw() { return a_id; }
553 Gets the command version. By default, messages initializes with value 1.
555 @return version Message version
557 U8 getVersion() const throw() { return a_version; }
560 Gets Message request indicator.
562 bool isRequest() const throw() { return a_id.second; }
565 Gets Message answer indicator.
567 bool isAnswer() const throw() { return !isRequest(); }
570 Gets the message application id
571 @return aid Application-id.
573 const U32 & getApplicationId() const throw() { return a_applicationId; }
576 Gets the message hop-by-hop
577 @return hbh Hop-by-hop identifier.
579 const U32 & getHopByHop() const throw() { return a_hopByHop; }
582 Gets the message end-to-end
583 @return ete End-to-end identifier.
585 const U32 & getEndToEnd() const throw() { return a_endToEnd; }
588 Gets stack command (dictionary command reference).
590 const anna::diameter::stack::Command *getStackCommand() const throw(anna::RuntimeException) { return getStackCommand(a_id); }
592 /** Returns R bit activation state */
593 bool requestBit() const throw() { return ((a_flags & RBitMask) != 0x00); }
595 /** Returns P bit activation state */
596 bool proxiableBit() const throw() { return ((a_flags & PBitMask) != 0x00); }
598 /** Returns E bit activation state */
599 bool errorBit() const throw() { return ((a_flags & EBitMask) != 0x00); }
601 /** Returns T bit activation state */
602 bool potentiallyReTransmittedMessageBit() const throw() { return ((a_flags & TBitMask) != 0x00); }
606 Access content for internal Avps. Exception mode allows different combinations like cascade access:
610 message->getAvp(anna::diameter::helpers::base::AVP__Multiple_Services_Credit_Control, anna::Exception::Mode::Throw)
611 ->getAvp(anna::diameter::helpers::base::AVP__Rating_Group, anna::Exception::Mode::Throw);
613 catch(anna::RuntimeException) {;}
619 const Avp *mscc = message->getAvp(anna::diameter::helpers::base::AVP__Multiple_Services_Credit_Control);
621 if (mscc) rg = mscc->getAvp(anna::diameter::helpers::base::AVP__Rating_Group);
624 Replacing procedures becomes easy because an Avp can be searched and its pointer reconfigured by mean #setId and data part setters.
625 Deleting procedures must use #removeAvp.
626 Access is internally cached to speed up the search operations. This cache is reset after calling #fix or #removeAvp methods.
628 @param id Avp identifier (pair code + vendor-id).
629 @param ocurrence Order of appearance for the searched avp. Zero position is rejected, but negative values could be used to reverse
630 access positions: i.e. -1 is the last ocurrence, -2 is the second to last (penultimate), etc.
631 @param emode Excepcion mode handling: Ignore (no action is taken), Throw (excepcion when missing avp), Trace (trace situation as warning).
633 const Avp* getAvp(AvpId id, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) const throw(anna::RuntimeException) {
634 return Avp::getAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine(), emode);
637 Avp* getAvp(AvpId id, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException) {
638 return const_cast<Avp*>(Avp::getAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine(), emode));
643 Same as #getAvp but providing dictionary logical name for Avp searched
645 const Avp* getAvp(const char *name, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) const throw(anna::RuntimeException) {
646 return _getAvp(name, ocurrence, emode);
649 Avp* getAvp(const char *name, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException) {
650 return const_cast<Avp*>(_getAvp(name, ocurrence, emode));
656 Counts the number of ocurrences of Avps (first level) with the identifier provided
658 @param id Avp identifier (pair code + vendor-id).
660 int countAvp(AvpId id) const throw() { return Avp::countAvp(a_avps, id); }
663 Same as #countAvp but providing dictionary logical name for Avp searched
665 int countAvp(const char *name) const throw(anna::RuntimeException);
668 Counts the number of children
670 @param id Avp identifier (pair code + vendor-id).
672 int countChilds() const throw() { return Avp::countChilds(a_avps); }
675 Encodes datablock with the class content. In case that validation is enabled (codec::Engine::ValidationMode) an exception will be launched
676 in a moment which depends on validation depth (codec::Engine::ValidationDepth). If you want to see validation errors but go on with encoding,
677 you should try/catch #valid() procedure out of #code.
679 @return DataBlock encoded (internal memory used)
681 const anna::DataBlock & code() throw(anna::RuntimeException);
684 Class xml representation
685 \param parent Parent XML node on which hold this instance information.
686 \return XML document with relevant information for this instance.
688 anna::xml::Node* asXML(anna::xml::Node* parent) const throw();
691 Class xml string representation
692 \return XML string representation with relevant information for this instance.
694 std::string asXMLString() const throw();
697 Comparison operator by mean serialization
699 @param m1 Instance 1 for Message class
700 @param m2 Instance 2 for Message class
702 @return Comparison result
704 friend bool operator == (const Message & m1, const Message & m2) throw() { return (m1.asXMLString() == m2.asXMLString()); }
707 Match a regular expression (string pattern) regarding xml string serialization for this message.
708 Using a complex pattern (many avps, grouped ones) it could be necessary to fix the message before
709 using the method in order to perform a more controlled comparison. In the same way, flags could be
710 ignored to simplify message xml presentation.
711 This powerful tool could be used to program traffic analysis and decide future behaviour (routing,
717 The pattern '<avp name="Service-Context-Id" data="(.)*32251@3gpp.org"/>' detects PS charging contexts
718 because of data suffix specification '32251@3gpp.org' for that AVP.
720 The pattern '<message version="1" name="Capabilities-Exchange-Request"' detects a CER message.
722 The pattern (string including carriage returns):
724 '<avp name="Subscription-Id">
725 <avp name="Subscription-Id-Type" data="0" alias="END_USER_E164"/>
726 <avp name="Subscription-Id-Data" data="606000106"/>
729 detects MSISDN (not IMSI) equal to 606000106
731 It would seems strange or 'creative' to use regular expressions within an hex string representation,
732 but anyway you could also do such kind of things to check non-printable data parts within the message:
733 for example, the pattern '<avp name="Framed-IP-Address" hex-data="0a[A-Fa-f0-9][A-Fa-f0-9]0a0a"/>'
734 matchs IP addresses for '10.x.10.10' where x = [0..255].
736 Note that string pattern could also be generated via #loadXML and then #asXML, that is to say, you
737 could get patterns through xml files which act as conditional triggers over message. In that case,
738 it is not possible to specify regular expressions within xml 'hex-data' fields because parser will fail
739 during hexadecimal read. Normally only printable 'data' fields are used for matching issues.
741 For example, imagine a 'pattern.xml' file like:
742 <message version="1" name="Credit-Control-Request" application-id="16777236" hop-by-hop-id="0" end-by-end-id="0">
743 <avp name="Subscription-Id">
744 <avp name="Subscription-Id-Type" data="0" alias="END_USER_E164"/>
745 <avp name="Subscription-Id-Data" data="616[0-9]{6,6}"/>
751 anna::diameter::codec::Message patternMessage;
752 patternMessage.loadXML("pattern.xml");
753 std::string pattern = patternMessage.getAvp("Subscription-Id")->getAvp("Subscription-Id-Type")->asXMLString();
754 // Former is '<avp name="Subscription-Id-Data" data="616[0-9]{6,6}"/>'
755 bool match = incomingMessage.isLike(pattern);
757 Then, messages having MSISDN numbers starting with '616' will match the pattern.
758 Note, that any other message codes (and not only Credit-Control-Request ones), could pass the test...
759 You could also build that string manually:
762 std::string pattern = "<avp name=\"Subscription-Id\">\n";
763 pattern += ANNA_XML_COMPILER_TAB; pattern += "<avp name=\"Subscription-Id-Type\" data=\"0\" alias=\"END_USER_E164\"/>\n"
764 pattern += ANNA_XML_COMPILER_TAB; pattern += "<avp name=\"Subscription-Id-Data\" data=\"616[0-9]{6,6}\"/>"
767 std::string pattern = "name=\"Subscription-Id\"(.)*name=\"Subscription-Id-Type\" data=\"0\"(.)*name=\"Subscription-Id-Data\" data=\"616[0-9]{6,6}\"";
770 \return Returns the match result
772 bool isLike(const std::string &pattern) const throw();
775 //friend class Engine;