Line data    Source code

       1             : 
       2             : /* Copyright (c) 2013-2014, Stefan.Eilemann@epfl.ch
       3             :  *
       4             :  * This library is free software; you can redistribute it and/or modify it under
       5             :  * the terms of the GNU Lesser General Public License version 2.1 as published
       6             :  * by the Free Software Foundation.
       7             :  *
       8             :  * This library is distributed in the hope that it will be useful, but WITHOUT
       9             :  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
      10             :  * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
      11             :  * details.
      12             :  *
      13             :  * You should have received a copy of the GNU Lesser General Public License
      14             :  * along with this library; if not, write to the Free Software Foundation, Inc.,
      15             :  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
      16             :  */
      17             : 
      18             : #ifndef LUNCHBOX_READYFUTURE_H
      19             : #define LUNCHBOX_READYFUTURE_H
      20             : 
      21             : #include <lunchbox/future.h> // base class
      22             : 
      23             : namespace lunchbox
      24             : {
      25             : /** A boolean future with a known value. Fully thread safe. */
      26             : template <bool value>
      27     6000006 : class FutureBool : public FutureImpl<bool>
      28             : {
      29             : protected:
      30           2 :     bool wait(const uint32_t) final { return value; }
      31           2 :     bool isReady() const final { return true; }
      32             : };
      33             : 
      34             : /** @return a boolean future being true. */
      35     2000001 : inline Future<bool> makeTrueFuture()
      36             : {
      37     2000001 :     return Future<bool>(new FutureBool<true>);
      38             : }
      39             : 
      40             : /** @return a boolean future being false. */
      41           1 : inline Future<bool> makeFalseFuture()
      42             : {
      43           1 :     return Future<bool>(new FutureBool<false>);
      44             : }
      45             : }
      46             : #endif // LUNCHBOX_READYFUTURE_H