src/client/Status.hh

/*
 * Copyright Staffan Gimåker 2006-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_STATUS_HH_INCLUDED
#define PEEKABOT_CLIENT_STATUS_HH_INCLUDED


#include <string>
#include <stdexcept>
#include <boost/shared_ptr.hpp>

#include "../Visibility.hh"
#include "OperationStatus.hh"


namespace peekabot
{
    namespace client
    {
        class PEEKABOT_API Status
        {
        public:
            Status();


            Status(boost::shared_ptr<OperationStatus> status);


            virtual ~Status();


            Status &operator=(
                boost::shared_ptr<OperationStatus> status);

            OperationOutcome get_outcome() const;

            bool has_completed() const;

            bool succeeded() const;

            bool failed() const;

            bool wait_until_completed() const;

            std::string get_error_message() const;

        private:
            boost::shared_ptr<OperationStatus> m_status;
        };
    }
}


#endif // PEEKABOT_CLIENT_STATUS_HH_INCLUDED