Add documentation on placing tiles.
[Tsunagari.git] / src / timeout.h
blobfe3d4351e583bacd0925b851ac704dcb38c83275
1 /****************************
2 ** Tsunagari Tile Engine **
3 ** timeout.h **
4 ** Copyright 2012 OmegaSDG **
5 ****************************/
7 // **********
8 // Permission is hereby granted, free of charge, to any person obtaining a copy
9 // of this software and associated documentation files (the "Software"), to
10 // deal in the Software without restriction, including without limitation the
11 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
12 // sell copies of the Software, and to permit persons to whom the Software is
13 // furnished to do so, subject to the following conditions:
15 // The above copyright notice and this permission notice shall be included in
16 // all copies or substantial portions of the Software.
18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 // IN THE SOFTWARE.
25 // **********
27 #ifndef TIMEOUT_H
28 #define TIMEOUT_H
30 #include <string>
32 #include <boost/python.hpp>
34 class Timeout {
35 public:
36 Timeout(boost::python::object callback, time_t delay);
37 void cancel();
39 bool isActive() const;
40 bool ready(time_t now) const;
41 time_t readyTime() const;
42 void execute();
44 //! Return a rought string representation of this object.
45 std::string repr() const;
47 private:
48 boost::python::object callback;
49 time_t start, delay;
50 bool active;
53 void updateTimeouts();
54 void exportTimeout();
56 #endif