Updated license
[anna.git] / include / anna / diameter / codec / tme / Engine.hpp
1 // ANNA - Anna is Not Nothingness Anymore
2 //
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
4 //
5 // https://bitbucket.org/testillano/anna
6 //
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
9 // are met:
10 //
11 //     * Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 //     * Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
16 // distribution.
17 //     * Neither the name of Google Inc. nor the names of its
18 // contributors may be used to endorse or promote products derived from
19 // this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
33 // Authors: eduardo.ramos.testillano@gmail.com
34 //          cisco.tierra@gmail.com
35
36
37 #ifndef anna_diameter_codec_tme_Engine_hpp
38 #define anna_diameter_codec_tme_Engine_hpp
39
40
41 // STL
42 #include <string>
43
44 #include <anna/core/util/Recycler.hpp>
45
46 #include <anna/diameter/codec/tme/Message.hpp>
47 #include <anna/diameter/codec/tme/Avp.hpp>
48 #include <anna/diameter/codec/EngineImpl.hpp>
49
50
51 using namespace anna::diameter::codec::tme;
52
53
54 //------------------------------------------------------------------------------
55 //---------------------------------------------------------------------- #define
56 //------------------------------------------------------------------------------
57
58
59 namespace anna {
60
61 namespace diameter {
62
63 namespace codec {
64
65 namespace tme {
66
67
68
69 /**
70  * Standard inheritance for engine component implementation, allocating basic Avp and Message classes.
71  */
72 class Engine : public EngineImpl {
73
74 public:
75
76   static const char* getClassName() throw() { return "anna::diameter::codec::tme::Engine"; }
77
78   Engine() : EngineImpl(getClassName()) {;}
79
80   void releaseAvp(anna::diameter::codec::Avp* avp) throw() {
81     if(avp == NULL) return;
82
83     Avp* aux = static_cast <Avp*>(avp);
84     aux->clear(); // free internal data-part storage specially for grouped avps which will release its childrens
85     a_avps.release(aux);
86   }
87
88   void releaseMessage(anna::diameter::codec::Message* message) throw() {
89     if(message == NULL) return;
90
91     Message* aux = static_cast <Message*>(message);
92     aux->clear(); // free internal data-part storage specially for childrens releasing
93     a_messages.release(aux);
94   }
95
96 protected:
97
98   anna::Recycler<Avp> a_avps;
99   anna::Recycler<Message> a_messages;
100
101   anna::diameter::codec::Avp* allocateAvp() throw() { return a_avps.create(); }
102   anna::diameter::codec::Message* allocateMessage() throw() { return a_messages.create(); }
103
104   friend class Message;
105   friend class Avp;
106 };
107
108 }
109 }
110 }
111 }
112
113 #endif
114