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.
184 * Setting a new different engine with different stack, even same engine where the
185 * stack has been dynamically changed, could cause a bad behaviour depending on the
186 * changes: in general, if the dictionary grows, nothing bad will happen, but if
187 * you remove or modified some elements which were processed with a certain format,
188 * will be interpreted as 'unknown' with the new dictionary, and then some problems
189 * may occur. If you add elements (vendors, avps, messages) is not a problem.
192 * 1) if you want to reuse the message, as a recommendation, you should set engine to
193 * NULL or use #clear. In that way, next operation will adjust automatically the needed
194 * engine because it would not be configured in such stage.
195 * 2) if you want to pre-configure the engine you will need to set the engine to NULL
196 * previously and then you could change to the new one without warning/ignoring.
197 * 3) if you have dedicated message objects for each interface (application id), then
198 * you could set the corresponding engine on constructor (or setEngine), and forget
199 * about #clear. The needed cleanup will be done automatically from decoding and xml
200 * loading procedures, and initialized engine will be kept along message operations.
202 void setEngine(Engine *engine) throw();
206 static const int HeaderLength;
217 // T(Potentially re-transmitted message)
218 // r(eserved) - these flag bits are reserved for future use, and
219 // MUST be set to zero, and ignored by the receiver.
220 static const U8 RBitMask;
221 static const U8 PBitMask;
222 static const U8 EBitMask;
223 static const U8 TBitMask;
230 // Virtual destructors are useful when you can delete an instance of a derived class through a pointer to base class:
231 // 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.
232 // My current solution: virtualizing method 'clear'
235 // To sum up, always make base classes' destructors virtual when they're meant to be manipulated polymorphically.
240 Sets the command identifier and clear the former content.
242 @param id Command identifier as pair (code,request-indicator).
244 void setId(CommandId id) throw(anna::RuntimeException);
247 Same as #setId but providing dictionary logical name for Avp searched
249 void setId(const char *name) throw(anna::RuntimeException);
252 Sets the command version. By default, messages initializes with value 1.
254 @param version Version provided
256 void setVersion(U8 version) throw() { a_version = version; }
259 Sets/unsets P 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.
262 @param activate Activates/deactivates the bit. True by default.
264 void setProxiableBit(bool activate = true) throw() { if(activate) a_flags |= PBitMask; else a_flags &= (~PBitMask); }
267 Sets/unsets E bit activation.
268 Application should not have to use this because dictionary information is used in order to configure flags when Message identifier is stored.
269 This flag MUST NOT be set in request messages (in this case, it will be ignored).
271 @param activate Activates/deactivates the bit. True by default.
273 void setErrorBit(bool activate = true) throw() { if(isRequest()) return; if(activate) a_flags |= EBitMask; else a_flags &= (~EBitMask); }
276 Sets/unsets T bit activation.
277 Application should not have to use this because dictionary information is used in order to configure flags when Message identifier is stored.
278 This flag MUST NOT be set in answer messages (in this case, it will be ignored).
280 @param activate Activates/deactivates the bit. True by default.
282 void setPotentiallyReTransmittedMessageBit(bool activate = true) throw() { if(isAnswer()) return; if(activate) a_flags |= TBitMask; else a_flags &= (~TBitMask); }
285 Sets the message application id.
287 The codec engine could be configured to force a stack selection based in this field value: see #selectStackWithApplicationId.
288 In multistack applications (in case of being monothread), you only have to take care about how to apply this method: the thing
289 is that you must not interleave message builds which belongs to different stacks. For example, you could think about setting the
290 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.
291 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
292 method). The result could be unexpected when adding/encoding messages with a dictionary which does not correspond.
294 @warning do not interleave build/encode operations between different messages which uses different stacks over the same codec engine.
295 It seems common sense, but it is not bad to advice about this.
297 @param aid Application-id.
299 void setApplicationId(U32 aid) throw(anna::RuntimeException);
302 Sets the message hop-by-hop
303 @param hbh Hop-by-hop identifier.
305 void setHopByHop(U32 hbh) throw() { a_hopByHop = hbh; }
308 Sets the message end-to-end
309 @param ete End-to-end identifier.
311 void setEndToEnd(U32 ete) throw() { a_endToEnd = ete; }
315 Sets header to be an answer regarding provided request message code.
316 Internally, updates command identifier (indeed request flag), promotes version, application identifier, hop-by-hop and end-to-end fields.
318 @param request Message to be answered.
320 @warning Request provided must be a request, in other case method do nothing.
322 void setHeaderToAnswer(const Message &request) throw(anna::RuntimeException) {
323 if(!request.getId().second) return;
325 a_engine = request.getEngine(); // we know this will be
327 setId(CommandId(request.getId().first, !request.getId().second));
328 setVersion(request.getVersion());
329 setApplicationId(request.getApplicationId());
330 setHopByHop(request.getHopByHop()); // The same Hop-by-Hop Identifier in the request is used in the answer (RFC 6733 Section 6.2).
331 setEndToEnd(request.getEndToEnd()); // The same End-to-End Identifier in the request is used in the answer (RFC 6733 Section 6.2).
332 setProxiableBit(request.proxiableBit()); // The 'P' bit is set to the same value as the one in the request (RFC 6733 Section 6.2).
337 Standard minimum-answer building from requests. Adds Session-Id (mirrored from request if present), Origin-Host and Origin-Realm
338 (which could be configured, extracted from optional Destination AVPs, etc.), and all the Proxy-Info AVPs (added in same order as
339 appear on the request). Of course, answer message header is built from request information through #setHeaderToAnswer. Finally,
340 message is fixed regarding dictionary elements order (#fix).
342 Summing up, as RFC 6733 Section 6.2, says:
346 6.2. Diameter Answer Processing
348 When a request is locally processed, the following procedures MUST be
349 applied to create the associated answer, in addition to any
350 additional procedures that MAY be discussed in the Diameter
351 application defining the command:
353 o The same Hop-by-Hop Identifier in the request is used in the
356 o The local host's identity is encoded in the Origin-Host AVP.
358 o The Destination-Host and Destination-Realm AVPs MUST NOT be
359 present in the answer message.
361 o The Result-Code AVP is added with its value indicating success or
364 o If the Session-Id is present in the request, it MUST be included
367 o Any Proxy-Info AVPs in the request MUST be added to the answer
368 message, in the same order they were present in the request.
370 o The 'P' bit is set to the same value as the one in the request.
372 o The same End-to-End identifier in the request is used in the
375 Note that the error messages (see Section 7) are also subjected to
376 the above processing rules.
378 Regarding errors, is recommended to use this over automatic answer built at #decode and/or #valid procedures, which would had added
379 Result-Code and/or Failed-AVP AVPs if proceed, but be aware of DIAMETER_COMMAND_UNSUPPORTED Result-Code, because becomes impossible
380 to fix (Session-Id SHOULD appear immediately following the Diameter header, and #fix do this manually even if no information about
381 the command structure is known, but perhaps another fixed AVPs could not comply... use #getResultCode to find out this situation before
382 using #setStandardToAnswer). Anyway, application could add another Failed-AVP content no detected internally, for example:
383 DIAMETER_CONTRADICTING_AVPS or DIAMETER_INVALID_AVP_BIT_COMBO). Also, application could add more Failed-AVP avps with other
384 wrong avps, or accumulate wrong avps inside the one and only Failed-AVP managed by the stack. The standard is open to add multiple
385 avps inside Failed-AVP or multiple Failed-AVP avps with single or multiple avps inside. This depends on application criteria regarding
386 other nodes. However, internally the Anna::diameter stack only provides one Failed-AVP with the first wrong avp found, as RFC 6733 says
389 If application decoding and/or validation operations are ok, user may search for other problems and put the appropiate Result-Code.
390 For example, DIAMETER_TOO_BUSY (3004) depends on congestion issues at business layer and cannot be decided with the only message
391 information automatically (not all the Result-Code values are taken into account, only those which correspond to anomalies managed
392 by anna::diameter::codec). Application Result-Codes could be provided in this prototype, being DIAMETER_SUCCESS the default value if missing.
395 @param request Message to be answered.
396 @param originHost Mandatory Origin-Host diameter identity value provided by application. If answer has already an Origin-Host, this will be ignored.
397 @param originRealm Mandatory Origin-Realm diameter identity value provided by application. If answer has already an Origin-Realm, this will be ignored.
398 @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.
400 @warning Request provided must be a request, in other case method do nothing.
402 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);
406 Sets a Result-Code AVP over an answer message (for requests, do nothing).
407 If Result-Code AVP doesn't exists, is added and then filled with the value provided.
408 If Result-Code AVP already exists, value detected is replaced if was DIAMETER_SUCCESS (non success codes are unchanged).
409 When provided value corresponds to an protocol error, that is to say within range [3001,3010], message (E)rror bit is
410 automatically activated.
412 This method is internally used during #decode and/or #valid procedures in order to build automatic answers, but application
413 could call this for set another Result-Code no detected by these methods within its category or for other one (application
414 layer). These are the Result-Codes implemented (detected) by ANNA::diameter::codec:
419 DIAMETER_COMMAND_UNSUPPORTED
420 DIAMETER_INVALID_HDR_BITS
421 DIAMETER_INVALID_AVP_BITS
425 DIAMETER_AVP_UNSUPPORTED (F)
426 DIAMETER_INVALID_AVP_VALUE (F)
427 DIAMETER_MISSING_AVP (F)
428 DIAMETER_AVP_NOT_ALLOWED (F)
429 DIAMETER_AVP_OCCURS_TOO_MANY_TIMES (F)
430 DIAMETER_INVALID_BIT_IN_HEADER
431 DIAMETER_INVALID_AVP_LENGTH (F)
432 DIAMETER_INVALID_MESSAGE_LENGTH
434 (F) Generates Failed-AVP (also DIAMETER_CONTRADICTING_AVPS and DIAMETER_INVALID_AVP_BIT_COMBO
435 values does, but these are not managed by anna::diameter::codec).
438 @param rc Result-Code value. DIAMETER_SUCCESS by default.
440 void setResultCode(int rc = helpers::base::AVPVALUES__Result_Code::DIAMETER_SUCCESS) throw(anna::RuntimeException);
444 Gets the Result-Code AVP value from an answer message (for requests, returns -1).
445 If missing, -1 value is returned.
447 @return Result-Code value for answers, -1 for request and answers without Result-Code AVP inside
449 int getResultCode() const throw();
453 Adds an avp child providing its identifier and reserve internal memory it.
455 @param id Avp identifier as pair (code,vendor-id).
457 @return Pointer to the new created avp.
459 Avp * addAvp(AvpId id) throw(anna::RuntimeException) { return Avp::addAvp(a_avps, a_insertionPositionForChilds, id, getEngine()); }
463 Same as #addAvp but providing dictionary logical name for Avp searched
465 Avp * addAvp(const char *name) throw(anna::RuntimeException);
469 Adds an avp child providing a persistent pointer (must be maintained by application).
470 It is not allowed to add an avp with no codec engine configured, neither if the engine
473 @param avp Avp external pointer. If NULL provided, nothing is done and NULL returned.
474 Also NULL returned for bad engine configuration.
476 @return Pointer to the added avp (again).
478 Avp * addAvp(Avp * avp) throw();
482 Removes an Avp within message (first level) and free resources.
484 @param id Avp identifier (pair code + vendor-id).
485 @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).
486 Negative values could be used to reverse access positions: i.e. -1 is the last ocurrence, -2 is the second to last (penultimate), etc.
488 @return Returns true if something was removed. False in other cases (including i.e. when this message is empty).
490 bool removeAvp(AvpId id, int ocurrence = 1) throw(anna::RuntimeException) { return Avp::removeAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine()); }
494 Same as #removeAvp but providing dictionary logical name for Avp searched
496 bool removeAvp(const char *name, int ocurrence = 1) throw(anna::RuntimeException);
500 * Clears and initializes Message class information.
501 * Application must clear auxiliary message objects before adding Avps in a new context if the same object is reused.
502 * Application don't need to clear a message object before decode operation (decode invokes #clear before any other task).
503 * Any reimplementation must first invoke base class method.
505 * @param resetEngine Sets to NULL the codec engine (true, default) or respect its current value (false). If you are going
506 * to reuse the message instance it is better to clear all the information (default) to manage different stacks, because if
507 * you don't initialize the engine to NULL, the second use of the message will keep the same engine deduced from the first
508 * decoding/loading operation, which could be wrong if the second message belongs to a different application identifier.
510 virtual void clear(bool resetEngine = true) throw(anna::RuntimeException);
513 Decodes buffer provided over class content. If an error ocurred, decoding will stop launching exception (fatal error) or a warning trace (perhaps the achieved
514 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
515 in a moment which depends on validation depth (codec::Engine::ValidationDepth).
517 You could decode multiple times over the same object. A basic cleanup is done respecting the codec engine.
519 @param db buffer data block processed. Before decoding, the whole message instance will be cleared (no need to invoke #clear before #decode).
520 @param ptrAnswer Answer set by application (could be empty or not), who is responsible for its memory reservation,
521 and automatically built regarding standard. If message analyzed realizes to be an answer, internal reference becomes
522 NULL because no answer is built for answers. By default, automatic answer is not built.
524 void decode(const anna::DataBlock &db, Message *ptrAnswer = NULL) throw(anna::RuntimeException);
527 Fix childrens content regarding dictionary avp positions.
528 Message could remain invalid because of possible fixed/mandatory avps.
529 This is useful to give flexibility to the application during message construction before encoding or representing the data.
530 Is not recommended to fix a recently decoded message because possible validation problems will be hidden.
535 Validates the message regarding dictionary rules like enumerated range, flags coherence, mandatory and fixed types, cardinality qualifiers, etc.
536 @return Boolean indicating validation result
537 @param ptrAnswer Answer set by application (could be empty or not), who is responsible for its memory reservation,
538 and automatically built regarding standard. If message analyzed realizes to be an answer, internal reference becomes
539 NULL because no answer is built for answers. By default, automatic answer is not built.
541 bool valid(Message *ptrAnswer = NULL) const throw(anna::RuntimeException);
544 Interpret xml data in order to dump over the class content.
545 You could apply this multiple times over the same object. A basic cleanup is done respecting the codec engine.
546 \param messageNode Message root node obtained from @functions::xmlFileTo
548 void fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeException);
551 * Interpret a xml file in order to create a diameter message
552 * You could apply this multiple times over the same object. A basic cleanup is done respecting the codec engine.
554 * @see functions::messageXmlDocumentFromXmlFile
557 * @param xmlPathFile Complete path file to the xml document which represents the diameter message
559 void loadXML(const std::string &xmlPathFile) throw(anna::RuntimeException);
565 Gets Message identifier as pair (code, request indicator).
567 const CommandId & getId() const throw() { return a_id; }
570 Gets the command version. By default, messages initializes with value 1.
572 @return version Message version
574 U8 getVersion() const throw() { return a_version; }
577 Gets Message request indicator.
579 bool isRequest() const throw() { return a_id.second; }
582 Gets Message answer indicator.
584 bool isAnswer() const throw() { return !isRequest(); }
587 Gets the message application id
588 @return aid Application-id.
590 const U32 & getApplicationId() const throw() { return a_applicationId; }
593 Gets the message hop-by-hop
594 @return hbh Hop-by-hop identifier.
596 const U32 & getHopByHop() const throw() { return a_hopByHop; }
599 Gets the message end-to-end
600 @return ete End-to-end identifier.
602 const U32 & getEndToEnd() const throw() { return a_endToEnd; }
605 Gets stack command (dictionary command reference).
607 const anna::diameter::stack::Command *getStackCommand() const throw(anna::RuntimeException) { return getStackCommand(a_id); }
609 /** Returns R bit activation state */
610 bool requestBit() const throw() { return ((a_flags & RBitMask) != 0x00); }
612 /** Returns P bit activation state */
613 bool proxiableBit() const throw() { return ((a_flags & PBitMask) != 0x00); }
615 /** Returns E bit activation state */
616 bool errorBit() const throw() { return ((a_flags & EBitMask) != 0x00); }
618 /** Returns T bit activation state */
619 bool potentiallyReTransmittedMessageBit() const throw() { return ((a_flags & TBitMask) != 0x00); }
623 Access content for internal Avps. Exception mode allows different combinations like cascade access:
627 message->getAvp(anna::diameter::helpers::base::AVP__Multiple_Services_Credit_Control, anna::Exception::Mode::Throw)
628 ->getAvp(anna::diameter::helpers::base::AVP__Rating_Group, anna::Exception::Mode::Throw);
630 catch(anna::RuntimeException) {;}
636 const Avp *mscc = message->getAvp(anna::diameter::helpers::base::AVP__Multiple_Services_Credit_Control);
638 if (mscc) rg = mscc->getAvp(anna::diameter::helpers::base::AVP__Rating_Group);
641 Replacing procedures becomes easy because an Avp can be searched and its pointer reconfigured by mean #setId and data part setters.
642 Deleting procedures must use #removeAvp.
643 Access is internally cached to speed up the search operations. This cache is reset after calling #fix or #removeAvp methods.
645 @param id Avp identifier (pair code + vendor-id).
646 @param ocurrence Order of appearance for the searched avp. Zero position is rejected, but negative values could be used to reverse
647 access positions: i.e. -1 is the last ocurrence, -2 is the second to last (penultimate), etc.
648 @param emode Excepcion mode handling: Ignore (no action is taken), Throw (excepcion when missing avp), Trace (trace situation as warning).
650 const Avp* getAvp(AvpId id, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) const throw(anna::RuntimeException) {
651 return Avp::getAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine(), emode);
654 Avp* getAvp(AvpId id, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException) {
655 return const_cast<Avp*>(Avp::getAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine(), emode));
660 Same as #getAvp but providing dictionary logical name for Avp searched
662 const Avp* getAvp(const char *name, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) const throw(anna::RuntimeException) {
663 return _getAvp(name, ocurrence, emode);
666 Avp* getAvp(const char *name, int ocurrence = 1, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException) {
667 return const_cast<Avp*>(_getAvp(name, ocurrence, emode));
673 Counts the number of ocurrences of Avps (first level) with the identifier provided
675 @param id Avp identifier (pair code + vendor-id).
677 int countAvp(AvpId id) const throw() { return Avp::countAvp(a_avps, id); }
680 Same as #countAvp but providing dictionary logical name for Avp searched
682 int countAvp(const char *name) const throw(anna::RuntimeException);
685 Counts the number of children
687 @param id Avp identifier (pair code + vendor-id).
689 int countChilds() const throw() { return Avp::countChilds(a_avps); }
692 Encodes datablock with the class content. In case that validation is enabled (codec::Engine::ValidationMode) an exception will be launched
693 in a moment which depends on validation depth (codec::Engine::ValidationDepth). If you want to see validation errors but go on with encoding,
694 you should try/catch #valid() procedure out of #code.
696 @return DataBlock encoded (internal memory used)
698 const anna::DataBlock & code() throw(anna::RuntimeException);
701 Class xml representation
702 \param parent Parent XML node on which hold this instance information.
703 \return XML document with relevant information for this instance.
705 anna::xml::Node* asXML(anna::xml::Node* parent) const throw();
708 Class xml string representation
709 \return XML string representation with relevant information for this instance.
711 std::string asXMLString() const throw();
714 Comparison operator by mean serialization
716 @param m1 Instance 1 for Message class
717 @param m2 Instance 2 for Message class
719 @return Comparison result
721 friend bool operator == (const Message & m1, const Message & m2) throw() { return (m1.asXMLString() == m2.asXMLString()); }
724 Match a regular expression (string pattern) regarding xml string serialization for this message.
725 Using a complex pattern (many avps, grouped ones) it could be necessary to fix the message before
726 using the method in order to perform a more controlled comparison. In the same way, flags could be
727 ignored to simplify message xml presentation.
728 This powerful tool could be used to program traffic analysis and decide future behaviour (routing,
734 The pattern '<avp name="Service-Context-Id" data="(.)*32251@3gpp.org"/>' detects PS charging contexts
735 because of data suffix specification '32251@3gpp.org' for that AVP.
737 The pattern '<message version="1" name="Capabilities-Exchange-Request"' detects a CER message.
739 The pattern (string including carriage returns):
741 '<avp name="Subscription-Id">
742 <avp name="Subscription-Id-Type" data="0" alias="END_USER_E164"/>
743 <avp name="Subscription-Id-Data" data="606000106"/>
746 detects MSISDN (not IMSI) equal to 606000106
748 It would seems strange or 'creative' to use regular expressions within an hex string representation,
749 but anyway you could also do such kind of things to check non-printable data parts within the message:
750 for example, the pattern '<avp name="Framed-IP-Address" hex-data="0a[A-Fa-f0-9][A-Fa-f0-9]0a0a"/>'
751 matchs IP addresses for '10.x.10.10' where x = [0..255].
753 Note that string pattern could also be generated via #loadXML and then #asXML, that is to say, you
754 could get patterns through xml files which act as conditional triggers over message. In that case,
755 it is not possible to specify regular expressions within xml 'hex-data' fields because parser will fail
756 during hexadecimal read. Normally only printable 'data' fields are used for matching issues.
758 For example, imagine a 'pattern.xml' file like:
759 <message version="1" name="Credit-Control-Request" application-id="16777236" hop-by-hop-id="0" end-by-end-id="0">
760 <avp name="Subscription-Id">
761 <avp name="Subscription-Id-Type" data="0" alias="END_USER_E164"/>
762 <avp name="Subscription-Id-Data" data="616[0-9]{6,6}"/>
768 anna::diameter::codec::Message patternMessage;
769 patternMessage.loadXML("pattern.xml");
770 std::string pattern = patternMessage.getAvp("Subscription-Id")->getAvp("Subscription-Id-Type")->asXMLString();
771 // Former is '<avp name="Subscription-Id-Data" data="616[0-9]{6,6}"/>'
772 bool match = incomingMessage.isLike(pattern);
774 Then, messages having MSISDN numbers starting with '616' will match the pattern.
775 Note, that any other message codes (and not only Credit-Control-Request ones), could pass the test...
776 You could also build that string manually:
779 std::string pattern = "<avp name=\"Subscription-Id\">\n";
780 pattern += ANNA_XML_COMPILER_TAB; pattern += "<avp name=\"Subscription-Id-Type\" data=\"0\" alias=\"END_USER_E164\"/>\n"
781 pattern += ANNA_XML_COMPILER_TAB; pattern += "<avp name=\"Subscription-Id-Data\" data=\"616[0-9]{6,6}\"/>"
784 std::string pattern = "name=\"Subscription-Id\"(.)*name=\"Subscription-Id-Type\" data=\"0\"(.)*name=\"Subscription-Id-Data\" data=\"616[0-9]{6,6}\"";
787 \return Returns the match result
789 bool isLike(const std::string &pattern) const throw();
792 //friend class Engine;