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_comm_Message_hpp
10 #define anna_diameter_comm_Message_hpp
13 #include <anna/diameter/defines.hpp>
14 #include <anna/diameter.comm/ClassCode.hpp>
16 #include <anna/core/RuntimeException.hpp>
17 #include <anna/comm/Message.hpp>
18 #include <anna/core/util/Millisecond.hpp>
19 #include <anna/core/functions.hpp>
42 Messages launched to diameter servers
43 Could be proxied (end-to-end kept) or not (by default).
45 class Message : public anna::comm::Message {
49 * Define las acciones a realizar en caso de que el temporizador de la petici�n expire.
51 struct OnExpiry { enum _v { Abandon, Ignore }; };
55 \param onExpiry Indica la acci�n a realizar si el temporizador de esta transaci�n expira.
57 Message(const OnExpiry::_v onExpiry = OnExpiry::Ignore) : anna::comm::Message(StatusCodeBuffer::Reserve),
58 a_classCode(ClassCode::ApplicationMessage),
59 a_onExpiry(onExpiry) { initialize(); }
62 Devuelve el tipo de la clase de esta peticion indicada en el contructor.
63 \return El tipo de la clase de esta peticion indicada en el contructor.
65 const ClassCode::_v & getClassCode() const throw() { return a_classCode; }
68 * Devuelve la acci�n a realizar en caso de que el temporizador asociado a esta petici�n expire.
69 * \return la acci�n a realizar en caso de que el temporizador asociado a esta petici�n expire.
71 OnExpiry::_v getOnExpiry() const throw() { return a_onExpiry; }
74 * Establece la acci�n a realizar en caso de que el temporizador asociado a esta petici�n expire.
75 * \param onExpiry Indica la acci�n a realizar en caso de que el temporizador asociado a esta petici�n expire.
77 * \warning Establecer el valor OnExpiry::Ignore podr�a causar p�rdida de memoria y uso innecesario de recursos.
79 void setOnExpiry(const OnExpiry::_v onExpiry) throw() { a_onExpiry = onExpiry; }
81 // Internal use (CER message)
82 void setClassCode(const ClassCode::_v & classCode) throw() { a_classCode = classCode; }
86 Class string representation
87 \return String with relevant information for this instance.
89 virtual std::string asString() const throw();
92 Class xml representation
93 \param parent Parent XML node on which hold this instance information.
94 \return XML document with relevant information for this instance.
96 virtual anna::xml::Node* asXML(anna::xml::Node* parent) const throw();
100 HopByHop getHopByHop() const throw();
101 EndToEnd getEndToEnd() const throw();
102 HopByHop getRequestHopByHop() const throw() { return a_requestHopByHop; }
103 EndToEnd getRequestEndToEnd() const throw() { return a_requestEndToEnd; }
104 void setRequestHopByHop(HopByHop hbh) throw() { a_requestHopByHop = hbh; }
105 void setRequestEndToEnd(EndToEnd ete) throw() { a_requestEndToEnd = ete; }
106 CommandId getCommandId(bool &isRequest) const throw();
107 CommandId getCommandId() const throw() { bool dummy; return getCommandId(dummy); }
108 ApplicationId getApplicationId() const throw();
110 bool fixRequestSequence(HopByHop hbh, EndToEnd ete) throw();
112 // http://diameter-protocol.blogspot.com.es/2011/05/diameter-message-structure-and-message.html
115 * In general, diameter agents CANNOT modify the end-to-end value during sending the message to the peer.
116 * That 'true' value stands for intermediate agents and also for retransmissions (must keep end-to-end
117 * during 4 minutes even upon reboots). False is used for new request created from end points (originators)
118 * as diameter clients.
120 bool updateEndToEnd() const throw() { return a_updateEndToEnd; }
123 * In general, diameter agents CANNOT modify the end-to-end value during sending the message to the peer.
124 * The appropiate behaviour must be configured before sending the message. By default, the diameter::comm
125 * message will sequence the end-to-end increasing the initial value created during session establishment.
127 void updateEndToEnd(bool update) throw() { a_updateEndToEnd = update; }
131 void updateRequestTimestampMs(void) throw() { a_request_timestamp_ms = anna::functions::millisecond(); }
132 const anna::Millisecond & getRequestTimestampMs() const throw() { return (a_request_timestamp_ms); }
134 int getRetries() const throw() { return a_retries; }
135 void setRetries(int value) throw() { a_retries = value; }
138 int getRequestServerSessionKey() const throw() { return a_requestServerSessionKey; }
140 /** Application specific socket id to keep origin track for request which came from a specific client, at asyncronous contexts (process with both diameter interfaces: client & entities) */
141 void setRequestServerSessionKey(int value) throw() { a_requestServerSessionKey = value; }
143 const std::string & getRequestClientSessionKey() const throw() { return a_requestClientSessionKey; }
145 /** Application specific socket id to keep origin track for request which came from a specific server (entity), at asyncronous contexts (process with both diameter interfaces: client & entities) */
146 void setRequestClientSessionKey(const std::string & value) throw() { a_requestClientSessionKey = value; }
148 /** Initializes class information */
149 void initialize() throw() {
151 a_requestServerSessionKey = -1; // means unknown/unset
152 a_requestClientSessionKey = ""; // means unknown/unset
153 a_requestHopByHop = 0;
154 a_requestEndToEnd = 0;
155 a_updateEndToEnd = true;
162 \param classCode Tipo de clase de esta peticion.
163 \param onExpiry Indica la acci�n a realizar si el temporizador de esta transaci�n expira.
165 Message(const ClassCode::_v & classCode, const OnExpiry::_v onExpiry = OnExpiry::Ignore) : anna::comm::Message(StatusCodeBuffer::Reserve),
166 a_classCode(classCode),
167 a_onExpiry(onExpiry) { initialize(); }
171 ClassCode::_v a_classCode;
172 OnExpiry::_v a_onExpiry;
173 anna::Millisecond a_request_timestamp_ms; // Lapsed timestamp milliseconds at request event. Used for statistic purposes.
175 int a_requestServerSessionKey; // useful to resolve origin of messages when diameter sessions are involved in the other side (if another interface, inherit from this Message class and put/carry context information)
176 std::string a_requestClientSessionKey; // idem for request which was received from servers
177 HopByHop a_requestHopByHop; // application backup for hop-by-hop in order to restore on answer receive
178 EndToEnd a_requestEndToEnd; // application backup for end-to-end in order to restore on answer receive
179 bool a_updateEndToEnd; // end-to-end will be updated
181 void send(ClientSession&) const throw(anna::RuntimeException);
182 void send(ServerSession&) const throw(anna::RuntimeException);
183 void restoreSequencesAfterFix() throw();
185 static const char* asText(const OnExpiry::_v) throw();
187 friend class Session;
188 friend class ClientSession;
189 friend class ServerSession;