Updated license
[anna.git] / include / anna / comm / Status.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_comm_Status_hpp
38 #define anna_comm_Status_hpp
39
40 #include <string>
41
42 namespace anna {
43 namespace comm {
44
45 /**
46    Estados en los que puede estar un proceso desde el punto de vista de las comunicaciones.
47    \see Communicator.
48 */
49 class Status {
50 public:
51   enum _v {
52     Available = 0, /**< Disponible para recibir peticiones */
53     Unavailable = 1, /**< No disponible para recibir peticiones, quizas debido al fallo de un servicio critico */
54     Overload = 2 /**< Sobrecargado */
55   };
56
57   Status() : a_value(Unavailable) {;}
58   Status(const Status& other) : a_value(other.a_value) {;}
59   Status(const _v v) : a_value(v) {;}
60   Status& operator = (const _v v) throw() { a_value = v; return *this; }
61   Status& operator = (const Status& other) throw() { a_value = other.a_value; return *this; }
62
63   bool operator != (const Status& other) const throw() { return a_value != other.a_value;  }
64   bool operator != (const Status::_v v) const throw() { return a_value != v ;  }
65   bool operator == (const Status& other) const throw() { return a_value == other.a_value;  }
66   bool operator == (const Status::_v v) const throw() { return a_value == v ;  }
67
68   _v value() const throw() { return a_value; }
69
70   std::string asString() const throw();
71
72 private:
73   _v a_value;
74 };
75
76 }
77 }
78
79
80 #endif
81