1 // ANNA - Anna is Not Nothingness Anymore
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
5 // http://redmine.teslayout.com/projects/anna-suite
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
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
17 // * Neither the name of the copyright holder 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.
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.
33 // Authors: eduardo.ramos.testillano@gmail.com
34 // cisco.tierra@gmail.com
37 #ifndef anna_core_mt_Semaphore_hpp
38 #define anna_core_mt_Semaphore_hpp
40 #include <semaphore.h>
42 #include <anna/core/functions.hpp>
43 #include <anna/core/RuntimeException.hpp>
44 #include <anna/core/mt/Safe.hpp>
48 //class RuntimeException;
51 Clase para facilitar el uso de semaforos.
53 Esta facilidad que nos ofrece el sistema operativo se suele usar para limitar el numero de
54 accesos a un determinado recurso.
56 La funcionalidad de esta clase solo estara disponible en aplicaciones multithread.
58 class Semaphore : public Safe {
64 @param count Numero de accesos simultaneos que permitimos sobre el recurso que queremos
66 \param mode Modo de actuacion de esta instancia en modo ST cuando montamos una
67 seccion critca sobre este objeto. En modo MT siempre sera Mode::Normal, es decir
68 abre una seccion critica sobre este objeto, que bloqueara a cualquier otro thread
69 que intente acceder a el.
71 Semaphore(unsigned int count);
79 Notifica que desea acceder al recurso. Si se ha alcanzado la cuenta maxima de accesos
80 simultaneos el thread que invoca a este metodo quedara bloqueado mientras que algun
81 otro threads no invoque al metodo #signal.
83 Cada llamada a este metodo debe tener su correspondiente llamada a #signal.
85 void wait() throw(RuntimeException);
88 Comprueba si se ha alcanzado la cuenta maxima de accesos simultaneos y devolvera \em
89 true si todavia es posible acceder sin quedar bloqueado o \em false en otro caso.
91 bool tryWait() throw(RuntimeException);
94 Decrementa la cuenta de utilizacion del recurso, con lo que algunos de los threads
95 que puede haber esperando se desbloqueara.
97 void signal() throw(RuntimeException);
100 Devuelve una cadena con informacion relevante de esta instancia.
101 \return Una cadena con informacion relevante de esta instancia.
103 virtual std::string asString() const throw();
107 Marca el inicio del acceso seguro a este objeto.
108 \warning Cada invocacion a este metodo debe tener su correspondiente llamada al metodo #unlock.
109 Es muy aconsejable delegar las llamadas a estos metodos en una instancia Guard.
110 \return Siempre devuelve \em true;
112 void lock() throw(RuntimeException) { wait(); }
115 Indica el final del acceso seguro iniciado al invocar #lock.
116 \warning Indica el final del acceso seguro iniciado al invocar #lock.
117 Es muy aconsejable delegar las llamadas a estos metodos en una instancia Guard.
118 \return Siempre devuelve \em true;
120 void unlock() throw() { signal(); }