Future.h

Go to the documentation of this file.

/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
* and international copyright treaties.
*
* Access to and use of the software is governed by the terms of the applicable OnixS Software
* Services Agreement (the Agreement) and Customer end user license agreements granting
* a non-assignable, non-transferable and non-exclusive license to use the software
* for it's own data processing purposes under the terms defined in the Agreement.
*
* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
* of this source code or associated reference material to any other location for further reproduction
* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
*
* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
* the terms of the Agreement is a violation of copyright law.
*/
 
#pragma once
 
#include <OnixS/CME/iLink3/ABI.h>
 
#if defined (ONIXS_ILINK3_CXX11)
#  include <exception>
#endif
 
namespace OnixS {
 
namespace System {
class FutureSharedState;
}
 
namespace CME {
namespace iLink3 {
namespace Threading {

struct FutureStatus
{
    enum Enum
    {
        ready,
        timeout,
        deferred
    };
};
 
namespace Implementation {
 
class FutureHelper;

class FutureBase
{
public:
    bool valid() const ONIXS_ILINK3_NOTHROW {
        return state_ != ONIXS_ILINK3_NULLPTR;
    }

    ONIXS_ILINK3_EXPORTED bool is_ready() const;

    ONIXS_ILINK3_EXPORTED bool has_value() const;

    ONIXS_ILINK3_EXPORTED bool has_exception() const;
 
#if defined (ONIXS_ILINK3_CXX11)

    ONIXS_ILINK3_EXPORTED std::exception_ptr get_exception_ptr() const;
 
#endif
 
    enum { InfiniteTimeout = -1 };

    ONIXS_ILINK3_EXPORTED FutureStatus::Enum wait(int timeoutInMs) const;
 
protected:
    FutureBase()
        : state_() {}
 
    ONIXS_ILINK3_EXPORTED FutureBase(const FutureBase & other) ONIXS_ILINK3_NOTHROW;
 
    ONIXS_ILINK3_EXPORTED FutureBase & operator=(const FutureBase & other) ONIXS_ILINK3_NOTHROW;
 
#if defined (ONIXS_ILINK3_CXX11)
 
    ONIXS_ILINK3_EXPORTED FutureBase(FutureBase && other) ONIXS_ILINK3_NOTHROW;
 
    ONIXS_ILINK3_EXPORTED FutureBase & operator=(FutureBase && other) ONIXS_ILINK3_NOTHROW;
 
#endif
 
    struct moving_init_t {};

    ONIXS_ILINK3_EXPORTED FutureBase(const System::FutureSharedState * state) ONIXS_ILINK3_NOTHROW;

    ONIXS_ILINK3_EXPORTED FutureBase(const System::FutureSharedState * state, moving_init_t) ONIXS_ILINK3_NOTHROW;

    ONIXS_ILINK3_EXPORTED ~FutureBase() ONIXS_ILINK3_NOTHROW;
 
    ONIXS_ILINK3_EXPORTED void swap(FutureBase & other) ONIXS_ILINK3_NOTHROW;
 
    ONIXS_ILINK3_EXPORTED const void * getValuePtr() const;
 
    ONIXS_ILINK3_EXPORTED void getVoid() const;
 
private:
    const System::FutureSharedState * state_;
 
    friend class FutureHelper;
};
 
template<typename T>
struct FutureGetReturn {
    typedef const T & Type;
};
 
template<>
struct FutureGetReturn<void> {
    typedef void Type;
};
 
}

template <typename T>
class SharedFuture : public Implementation::FutureBase
{
public:
    SharedFuture() ONIXS_ILINK3_NOTHROW
        : FutureBase() {}

    SharedFuture(const SharedFuture<T> & other) ONIXS_ILINK3_NOTHROW
        : FutureBase(other) {}

    SharedFuture<T> & operator=(const SharedFuture<T> & other) ONIXS_ILINK3_NOTHROW {
        FutureBase::operator=(other);
        return *this;
    }
 
#if defined (ONIXS_ILINK3_CXX11)
 
    SharedFuture(SharedFuture<T> && other) ONIXS_ILINK3_NOTHROW
        : FutureBase(std::move(other)) {}
 
    FutureBase & operator=(SharedFuture<T> && other) ONIXS_ILINK3_NOTHROW {
        FutureBase::operator=(std::move(other));
        return *this;
    }
 
#endif

    typename Implementation::FutureGetReturn<T>::Type get() const {
        return *reinterpret_cast<const T *>(getValuePtr());
    }

    void swap(SharedFuture<T> & other) ONIXS_ILINK3_NOTHROW {
        FutureBase::swap(other);
    }
 
private:
    SharedFuture(const System::FutureSharedState * state)
        : FutureBase(state) {}

    SharedFuture(const System::FutureSharedState * state, moving_init_t t) ONIXS_ILINK3_NOTHROW
        : FutureBase(state, t) {}
 
    friend class Implementation::FutureHelper;
};
 
template<>
inline void SharedFuture<void>::get() const {
    getVoid();
}
 
}
}
}
}