include/anna/comm/ReceiverFactory.hpp

   1 // ANNA - Anna is Not 'N' 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_comm_ReceiverFactory_hpp
  38 #define anna_comm_ReceiverFactory_hpp
  39
  40 #include <anna/core/RuntimeException.hpp>
  41 #include <anna/core/mt/Mutex.hpp>
  42 #include <anna/config/defines.hpp>
  43
  44 namespace anna {
  45
  46 namespace xml {
  47 class Node;
  48 }
  49
  50 namespace comm {
  51
  52 class Receiver;
  53
  54 /**
  55    Interface for receivers factories.
  56
  57    Is recommended (performance  issues) to use #Recycler<T> as in the following example:
  58
  59    \code
  60
  61    class MyReceiver;
  62
  63    class MyReceiverFactory : public ReceiverFactory {
  64    public:
  65       MyReceiverFactory () : ReceiverFactory ("MyReceiverFactory") {;}
  66
  67    private:
  68       anna::Recycler<MyReceiver> a_receivers;
  69
  70       Receiver* do_create () throw () { return a_receivers.create (); }
  71       void do_release (Receiver* receiver) throw () { a_receivers.release (static_cast <MyReceiver*> (receiver)); }
  72    };
  73
  74    \endcode
  75
  76    In most of cases, is recommended to use an comm::ReceiverFactoryImpl instance with the receiver type used in our application.
  77
  78    \see Receiver
  79    \see ReceiverFactoryImpl
  80 */
  81 class ReceiverFactory : public Mutex {
  82 public:
  83   /**
  84      Returns the logical name for this receiver factory.
  85      @return logical name for this receiver factory.
  86   */
  87   const std::string& getName() const throw() { return a_name; }
  88
  89   /**
  90      Creates a receiver instance for this factory. Reuse resources when needed.
  91
  92      \return The new receiver instance.
  93      \warning All the receivers obtained shall be released by mean #release.
  94   */
  95   Receiver* create() throw(RuntimeException);
  96
  97   /**
  98      Release the receiver instance provided.
  99
 100      \return The receiver instance to be released.
 101      \warning The parameter should have been obtained by mean #create.
 102   */
 103   void release(Receiver* receiver) throw();
 104
 105   /**
 106      Returns a string with relevant information for this instance.
 107      @return string with relevant information for this instance.
 108   */
 109   std::string asString() const
 110   throw() {
 111     std::string msg("anna::comm::ReceiverFactory { Name: ");
 112     msg += a_name;
 113     return msg += " }";
 114   }
 115
 116   /**
 117      Returns a XML document with relevant information for this instance.
 118      \param parent XML node from which created data will depend on.
 119      @return a XML document with relevant information for this instance.
 120   */
 121   xml::Node* asXML(xml::Node* parent) const throw();
 122
 123 protected:
 124   /**
 125      Constructor.
 126      \param name Logical name for this receivers factory.
 127   */
 128   ReceiverFactory(const char* name);
 129
 130   /**
 131      Creates the receiver instance if no other reusable instance is found. This method is
 132      called from a critical section activated for this instance.
 133
 134      \return The new receiver instance.
 135      \warning All the receivers obtained shall be released by mean #release.
 136   */
 137   virtual Receiver* do_create() throw() = 0;
 138
 139   /**
 140      Release the receiver provided. This method is called from a critical section activated
 141      for this instance.
 142
 143      \param The receiver instance to be released.
 144   */
 145   virtual void do_release(Receiver* receiver) throw() = 0;
 146
 147 private:
 148   const std::string a_name;
 149
 150   ReceiverFactory(const ReceiverFactory&);
 151
 152   WHEN_SINGLETHREAD(Receiver* a_receiver;)
 153 };
 154
 155 }
 156 }
 157
 158 #endif