X-Git-Url: https://git.teslayout.com/public/public/public/?a=blobdiff_plain;f=include%2Fanna%2Fdiameter.comm%2FMessage.hpp;h=6e9acf3ddd666aca94f6746fb00bbfb3db937cb4;hb=f34b8069233e9e09208339bb79d8576c1ff962e1;hp=58158ebb608bf5a3ae1bed9eb222df86599ec5c1;hpb=39033fd99e58e994a5e98c1060dcc79e0d81f9c9;p=anna.git diff --git a/include/anna/diameter.comm/Message.hpp b/include/anna/diameter.comm/Message.hpp index 58158eb..6e9acf3 100644 --- a/include/anna/diameter.comm/Message.hpp +++ b/include/anna/diameter.comm/Message.hpp @@ -1,37 +1,9 @@ -// ANNA - Anna is Not Nothingness Anymore -// -// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo -// -// http://redmine.teslayout.com/projects/anna-suite -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions -// are met: -// -// * Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// * Redistributions in binary form must reproduce the above -// copyright notice, this list of conditions and the following disclaimer -// in the documentation and/or other materials provided with the -// distribution. -// * Neither the name of the copyright holder nor the names of its -// contributors may be used to endorse or promote products derived from -// this software without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -// -// Authors: eduardo.ramos.testillano@gmail.com -// cisco.tierra@gmail.com +// ANNA - Anna is Not Nothingness Anymore // +// // +// (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo // +// // +// See project site at http://redmine.teslayout.com/projects/anna-suite // +// See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE // #ifndef anna_diameter_comm_Message_hpp @@ -68,18 +40,19 @@ class ServerSession; /** Messages launched to diameter servers + Could be proxied (end-to-end kept) or not (by default). */ class Message : public anna::comm::Message { public: /** - * Define las acciones a realizar en caso de que el temporizador de la petición expire. + * Define las acciones a realizar en caso de que el temporizador de la petici�n expire. */ - struct OnExpiry { enum _v { Abandon, Ignore }; }; + struct OnExpiry { enum _v { Abandon, Ignore, Retransmit }; }; /** Constructor. - \param onExpiry Indica la acción a realizar si el temporizador de esta transación expira. + \param onExpiry Indica la acci�n a realizar si el temporizador de esta transaci�n expira. */ Message(const OnExpiry::_v onExpiry = OnExpiry::Ignore) : anna::comm::Message(StatusCodeBuffer::Reserve), a_classCode(ClassCode::ApplicationMessage), @@ -89,77 +62,104 @@ public: Devuelve el tipo de la clase de esta peticion indicada en el contructor. \return El tipo de la clase de esta peticion indicada en el contructor. */ - const ClassCode::_v & getClassCode() const throw() { return a_classCode; } + const ClassCode::_v & getClassCode() const { return a_classCode; } /** - * Devuelve la acción a realizar en caso de que el temporizador asociado a esta petición expire. - * \return la acción a realizar en caso de que el temporizador asociado a esta petición expire. + * Devuelve la acci�n a realizar en caso de que el temporizador asociado a esta petici�n expire. + * \return la acci�n a realizar en caso de que el temporizador asociado a esta petici�n expire. */ - OnExpiry::_v getOnExpiry() const throw() { return a_onExpiry; } + OnExpiry::_v getOnExpiry() const { return a_onExpiry; } /** - * Establece la acción a realizar en caso de que el temporizador asociado a esta petición expire. - * \param onExpiry Indica la acción a realizar en caso de que el temporizador asociado a esta petición expire. + * Establece la acci�n a realizar en caso de que el temporizador asociado a esta petici�n expire. + * \param onExpiry Indica la acci�n a realizar en caso de que el temporizador asociado a esta petici�n expire. * - * \warning Establecer el valor OnExpiry::Ignore podría causar pérdida de memoria y uso innecesario de recursos. + * \warning Establecer el valor OnExpiry::Ignore podr�a causar p�rdida de memoria y uso innecesario de recursos. */ - void setOnExpiry(const OnExpiry::_v onExpiry) throw() { a_onExpiry = onExpiry; } + void setOnExpiry(const OnExpiry::_v onExpiry) { a_onExpiry = onExpiry; } // Internal use (CER message) - void setClassCode(const ClassCode::_v & classCode) throw() { a_classCode = classCode; } + void setClassCode(const ClassCode::_v & classCode) { a_classCode = classCode; } /** Class string representation \return String with relevant information for this instance. */ - virtual std::string asString() const throw(); + virtual std::string asString() const ; /** Class xml representation \param parent Parent XML node on which hold this instance information. \return XML document with relevant information for this instance. */ - virtual anna::xml::Node* asXML(anna::xml::Node* parent) const throw(); + virtual anna::xml::Node* asXML(anna::xml::Node* parent) const ; // Helpers - HopByHop getHopByHop() const throw(); - EndToEnd getEndToEnd() const throw(); - HopByHop getRequestHopByHop() const throw() { return a_requestHopByHop; } - EndToEnd getRequestEndToEnd() const throw() { return a_requestEndToEnd; } - void setRequestHopByHop(HopByHop hbh) throw() { a_requestHopByHop = hbh; } - void setRequestEndToEnd(EndToEnd ete) throw() { a_requestEndToEnd = ete; } - CommandId getCommandId(bool &isRequest) const throw(); - CommandId getCommandId() const throw() { bool dummy; return getCommandId(dummy); } + HopByHop getHopByHop() const ; + EndToEnd getEndToEnd() const ; + HopByHop getRequestHopByHop() const { return a_requestHopByHop; } + EndToEnd getRequestEndToEnd() const { return a_requestEndToEnd; } + void setRequestHopByHop(HopByHop hbh) { a_requestHopByHop = hbh; } + void setRequestEndToEnd(EndToEnd ete) { a_requestEndToEnd = ete; } + CommandId getCommandId(bool &isRequest) const ; + CommandId getCommandId() const { bool dummy; return getCommandId(dummy); } + ApplicationId getApplicationId() const ; + + bool fixRequestSequence(HopByHop hbh, EndToEnd ete) ; + + // http://diameter-protocol.blogspot.com.es/2011/05/diameter-message-structure-and-message.html + + /** + * In general, diameter nodes will sequence the End-To-End value when sending new requests. + * A 'false' value stands for intermediate agents (must keep end-to-end during 4 minutes even upon reboots). + */ + bool endToEndSequenced() const { return a_endToEndSequenced; } + + /** + * By default, the diameter::comm message will sequence the end-to-end increasing the initial value created + * during session establishment. Anyway you could change this behaviour with this method. + * + * @see sequenceEndToEnd + */ + void forwardEndToEnd() { a_endToEndSequenced = false; } + + /** + * By default, the diameter::comm message will sequence the end-to-end increasing the initial value created + * during session establishment. Anyway you could set again this behaviour with this method. + * + * @see forwardEndToEnd + */ + void sequenceEndToEnd() { a_endToEndSequenced = true; } - bool fixRequestSequence(HopByHop hbh, EndToEnd ete, bool freezeEndToEnd) throw(); // Statistics - void updateRequestTimestampMs(void) throw() { a_request_timestamp_ms = anna::functions::millisecond(); } - const anna::Millisecond & getRequestTimestampMs() const throw() { return (a_request_timestamp_ms); } + void updateRequestTimestampMs(void) { a_request_timestamp_ms = anna::functions::millisecond(); } + const anna::Millisecond & getRequestTimestampMs() const { return (a_request_timestamp_ms); } - int getRetries() const throw() { return a_retries; } - void setRetries(int value) throw() { a_retries = value; } + int getRetries() const { return a_retries; } + void setRetries(int value) { a_retries = value; } - int getRequestServerSessionKey() const throw() { return a_requestServerSessionKey; } + int getRequestServerSessionKey() const { return a_requestServerSessionKey; } /** 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) */ - void setRequestServerSessionKey(int value) throw() { a_requestServerSessionKey = value; } + void setRequestServerSessionKey(int value) { a_requestServerSessionKey = value; } - const std::string & getRequestClientSessionKey() const throw() { return a_requestClientSessionKey; } + const std::string & getRequestClientSessionKey() const { return a_requestClientSessionKey; } /** 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) */ - void setRequestClientSessionKey(const std::string & value) throw() { a_requestClientSessionKey = value; } + void setRequestClientSessionKey(const std::string & value) { a_requestClientSessionKey = value; } /** Initializes class information */ - void initialize() throw() { - a_retries = 0; + void initialize() { + a_retries = 1; a_requestServerSessionKey = -1; // means unknown/unset a_requestClientSessionKey = ""; // means unknown/unset a_requestHopByHop = 0; a_requestEndToEnd = 0; + a_endToEndSequenced = true; } @@ -167,7 +167,7 @@ protected: /** Constructor. \param classCode Tipo de clase de esta peticion. - \param onExpiry Indica la acción a realizar si el temporizador de esta transación expira. + \param onExpiry Indica la acci�n a realizar si el temporizador de esta transaci�n expira. */ Message(const ClassCode::_v & classCode, const OnExpiry::_v onExpiry = OnExpiry::Ignore) : anna::comm::Message(StatusCodeBuffer::Reserve), a_classCode(classCode), @@ -183,12 +183,13 @@ private: std::string a_requestClientSessionKey; // idem for request which was received from servers HopByHop a_requestHopByHop; // application backup for hop-by-hop in order to restore on answer receive EndToEnd a_requestEndToEnd; // application backup for end-to-end in order to restore on answer receive + bool a_endToEndSequenced; // end-to-end will be sequenced by default (true) - void send(ClientSession&) const throw(anna::RuntimeException); - void send(ServerSession&) const throw(anna::RuntimeException); - void restoreSequencesAfterFix() throw(); + void send(ClientSession&) const noexcept(false); + void send(ServerSession&) const noexcept(false); + void restoreSequencesAfterFix() ; - static const char* asText(const OnExpiry::_v) throw(); + static const char* asText(const OnExpiry::_v) ; friend class Session; friend class ClientSession;