Updated license
[anna.git] / include / anna / comm / internal / Poll.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_internal_Poll_hpp
38 #define anna_comm_internal_Poll_hpp
39
40 #include <unistd.h>
41 #include <sys/time.h>
42 #include <limits.h>
43
44 #include <anna/config/defines.hpp>
45 #include <anna/core/util/defines.hpp>
46 #include <anna/core/RuntimeException.hpp>
47 #include <anna/core/functions.hpp>
48
49 namespace anna {
50
51 namespace comm {
52
53 /**
54    Clase que asegura que el comm::Reader no se quedara esperando indefinidamente a
55    que un determinado mensaje haya sido tratado y mantiene la integridad de forma
56    ya que asegura que el tratamiento de un mensaje solo tendra un unico signal enviado
57     hacia el comm::Reader.
58 */
59 class Poll {
60 public:
61   Poll() : a_maxfd(0), a_ptrTimeout(NULL), a_minfd(INT_MAX) {
62     FD_ZERO(&a_fdmask);
63     FD_ZERO(&a_fdset);
64   }
65
66   void setTimeout(const Millisecond &timeout) throw();
67
68   void waitMessage() throw(RuntimeException);
69   int fetch() throw();
70   bool isEmpty() const throw() { return a_pollr <= 0; }
71   void clear() throw() { a_maxfd = 0; a_minfd = INT_MAX; FD_ZERO(&a_fdmask); FD_ZERO(&a_fdset);}
72   void insert(const int fd) throw();
73   void erase(const int fd) throw();
74
75 private:
76   fd_set a_fdmask;
77   fd_set a_fdset;
78   int a_minfd;
79   int a_maxfd;
80   int a_pollr;
81   int a_ifd;
82   timeval a_timeout;
83   timeval* a_ptrTimeout;
84
85   static int select(const int maxfd, fd_set* fdset, timeval* timeout)
86   throw(RuntimeException) {
87     int result;
88
89     do {
90       result = ::select(maxfd + 1, fdset, NULL, NULL, timeout);
91     } while(result == -1 && errno == EINTR);
92
93     if(result == -1) {
94       int xerrno = errno;
95       throw RuntimeException("Error en anna::comm::Poll::select", xerrno, ANNA_FILE_LOCATION);
96     }
97
98     return result;
99   }
100
101   static int min(const Millisecond &n1, const Millisecond &n2) throw() { return (n1 < n2) ? n1 : n2; }
102 };
103
104 }
105 }
106
107 #endif