/**
 * Orthanc - A Lightweight, RESTful DICOM Store
 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
 * Department, University Hospital of Liege, Belgium
 * Copyright (C) 2017-2023 Osimis S.A., Belgium
 * Copyright (C) 2024-2026 Orthanc Team SRL, Belgium
 * Copyright (C) 2021-2026 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 **/


#pragma once

#include "../Compatibility.h"
#include "../IDynamicObject.h"
#include "../OrthancException.h"

#include <boost/thread/mutex.hpp>
#include <boost/thread/condition_variable.hpp>

namespace Orthanc
{
  namespace Internals
  {
    class FutureState : public boost::noncopyable
    {
    public:
      enum State
      {
        State_Pending,
        State_Success,
        State_Failed,
        State_Canceled
      };

    private:
      boost::mutex                       mutex_;
      boost::condition_variable          completed_;
      State                              state_;
      std::unique_ptr<IDynamicObject>    result_;
      std::unique_ptr<OrthancException>  error_;

      IDynamicObject* ReleaseInternal(bool hasTimeout,
                                      unsigned int millisecondsTimeout);

    public:
      FutureState() :
        state_(State_Pending)
      {
      }

      IDynamicObject* ReleaseResult()
      {
        return ReleaseInternal(false, 0);
      }

      IDynamicObject* ReleaseResult(unsigned int millisecondsTimeout)
      {
        return ReleaseInternal(true, millisecondsTimeout);
      }

      void Cancel() ORTHANC_NOEXCEPT;

      void AcquireResult(IDynamicObject* result /* takes ownership */);

      void SetError(const OrthancException& error);
    };
  }
}