include/anna/core/mt/NRMutex.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_core_mt_NRMutex_hpp
  38 #define anna_core_mt_NRMutex_hpp
  39
  40 #include <anna/core/mt/Mutex.hpp>
  41
  42 namespace anna {
  43
  44 /**
  45    Clase para implementar secciones criticas no-reentrantes. El uso general sera el siguiente:
  46
  47    \code
  48       mutex.lock ();
  49
  50       try {
  51        <implementacion de la seccion critica>
  52
  53         mutex.unlock ();
  54       }
  55       catch (Exception&) {
  56         mutex.unlock ();
  57         .... tratamiento de la excepcion ...
  58       }
  59    \endcode
  60
  61    La funcionalidad de esta clase solo estara disponible en aplicaciones multithread.
  62
  63    @see anna::Guard
  64    @see anna::Thread
  65    @see anna::Semaphore
  66 */
  67 class NRMutex : public Mutex {
  68 public:
  69   /**
  70     Constructor.
  71   */
  72   NRMutex() : Mutex(Mode::Strict) { ; }
  73 };
  74
  75 } //namespace anna
  76
  77 #endif