SDOFuture.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 MetraLabs GmbH (MLAB), GERMANY.
 * All rights reserved.
 * Contact: info@MetraLabs.com
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MetraLabs.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file.  Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MetraLabs (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
 * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE
 * OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLABS" HAS BEEN
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN
 * "AS IS" BASIS, AND "MLAB" HAS NO OBLIGATION TO PROVIDE MAINTENANCE,
 * SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MLAB_SDOFUTURE_H_
#define _MLAB_SDOFUTURE_H_

#ifndef Q_MOC_RUN
#include <boost/thread/future.hpp>
#endif

namespace mira { namespace can {


class SDOClientBase
{
public:
    virtual ~SDOClientBase() {}

    virtual void onDestructFuture(uint64 requestID) = 0;
};


template <typename R>
class SDOFutureCommon
{
public:

    SDOFutureCommon() : mClient(NULL), mRequestID(0) {}

    SDOFutureCommon(SDOClientBase* client, uint64 requestID) :
        mClient(client), mRequestID(requestID) {}

    ~SDOFutureCommon()
    {
        // remove call upon destruction of this future
        if(mClient!=NULL)
            mClient->onDestructFuture(mRequestID);
    }

public:
    // delegate to boost future

    bool isReady() const { return mFuture.is_ready(); }

    bool hasException() const { return mFuture.has_exception(); }

    bool hasValue() const { return mFuture.has_value(); }

    void wait() const { mFuture.wait(); }

    template<typename Duration>
    bool timedWait(Duration const& relTime) const {
        return mFuture.timed_wait(relTime);
    }

    bool timedWaitUntil(boost::system_time const& absTime) const {
        return mFuture.timed_wait_until(absTime);
    }

    void swap(SDOFutureCommon<R>& other) {
        mFuture.swap(other.mFuture);
        std::swap(mClient, other.mClient);
        std::swap(mRequestID, other.mRequestID);
    }


protected:
    SDOClientBase* mClient;
    uint64 mRequestID;
    boost::unique_future<R> mFuture;
};


template <typename R>
class SDOFuture : public SDOFutureCommon<R>
{
public:
    SDOFuture() {}

    SDOFuture(boost::unique_future<R> other, SDOClientBase* client,
              uint64 requestID) :
        SDOFutureCommon<R>(client, requestID)
    {
        this->mFuture.swap(other);
    }

    SDOFuture(SDOFuture&& other) {
        this->swap(other);
    }

    SDOFuture& operator=(SDOFuture && other) {
        this->swap(other);
        return *this;
    }

public:

#if BOOST_VERSION / 100 % 1000 > 56
    typedef typename boost::detail::shared_state<R>::move_dest_type ReturnValue;
#else
    typedef typename boost::detail::future_traits<R>::move_dest_type ReturnValue;
#endif

    operator ReturnValue() { return this->mFuture.get(); }

    ReturnValue get() { return this->mFuture.get(); }
};


template <>
class SDOFuture<void> : public SDOFutureCommon<void>
{
public:
    SDOFuture() {}

    SDOFuture(boost::unique_future<void> other, SDOClientBase* client,
              uint64 requestID) :
        SDOFutureCommon<void>(client, requestID)
    {
        this->mFuture.swap(other);
    }

    SDOFuture(SDOFuture&& other) {
        this->swap(other);
    }

    SDOFuture& operator=(SDOFuture && other) {
        this->swap(other);
        return *this;
    }

    void get() { this->mFuture.get(); }
};


}} // namespaces

#endif