/**
 * Stone of Orthanc
 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
 * Department, University Hospital of Liege, Belgium
 * Copyright (C) 2017-2023 Osimis S.A., 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 "IOracleClient.h"

#include <boost/weak_ptr.hpp>


namespace OrthancStone
{
  class IEnvironment : public boost::noncopyable
  {
  public:
    class ILock : public boost::noncopyable
    {
    public:
      virtual ~ILock()
      {
      }
    };

    virtual ~IEnvironment()
    {
    }

    virtual ILock* AcquireLock() = 0;

    /**
     * NB: "command" and "result" must be pointers so that they can be
     * queued, in order to uncouple the worker threads of the oracle
     * from the mutex of the native environment. Check out
     * "NativeEnvironment.cpp".
     **/
    virtual void NotifyOracleSuccess(const boost::weak_ptr<IOracleClient>& client,
                                     IOracleCommand* command /* takes ownership */,
                                     IMessage* result /* takes ownership */) = 0;

    virtual void NotifyOracleError(const boost::weak_ptr<IOracleClient>& client,
                                   IOracleCommand* command /* takes ownership */,
                                   const Orthanc::OrthancException& error) = 0;
  };
}