src/client/OperationStatus.hh

/*
 * Copyright Staffan Gimåker 2007-2010.
 *
 * ---
 *
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE_1_0.txt or copy at
 * http://www.boost.org/LICENSE_1_0.txt)
 */

#ifndef PEEKABOT_CLIENT_OPERATION_STATUS_HH_INCLUDED
#define PEEKABOT_CLIENT_OPERATION_STATUS_HH_INCLUDED


#include <string>
#include <boost/utility.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/thread/condition.hpp>


namespace peekabot
{
    namespace client
    {
        enum OperationOutcome
        {
            OUTCOME_PENDING = 0,

            OPERATION_SUCCEEDED = 1,

            OPERATION_FAILED = 2
        };


        class OperationStatus : public boost::noncopyable
        {
        public:
            OperationStatus();


            virtual ~OperationStatus();


            OperationOutcome get_outcome() const;


            void set_outcome(
                OperationOutcome outcome,
                const std::string &error_msg = "");


            std::string get_error_msg() const;


            bool wait_until_completed() const;


            void wake() const;

            void client_disconnected();

        private:
            mutable boost::mutex m_mutex;

            OperationOutcome m_outcome;

            std::string m_error_msg;

            mutable boost::condition m_outcome_cond;

            volatile bool m_client_was_disconnected;
        };
    }
}

#endif // PEEKABOT_CLIENT_OPERATION_STATUS_HH_INCLUDED