CachedFactoryIOThread.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: IOFactory
File: CachedFactoryIOThread
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#if NDEVR_SUPPORTS_THREADING
#include <NDEVR/ModelFactory.h>
#include <NDEVR/Thread.h>
#include <NDEVR/File.h>
#include <mutex>
namespace NDEVR
{
    class DesignObjectLookup;
    /**--------------------------------------------------------------------------------------------------
    \brief A thread designed to read and write files using the FactoryIO interface. Thread will perform
        all actions on a temp file, then move the file when accept() is called.
     **/
    class NDEVR_FACTORY_API CachedFactoryIOThread : public Thread
    {
    public:
        CachedFactoryIOThread(bool is_read);
        void run() override;
        void setFiles(const Buffer<FactoryParameters>& files);
        bool isFinished() const;
        void requestStopLoad();
        void kill(bool terminate_current);
 
        bool writeTempFiles();
        void deleteTempFiles();
        void deleteReadIDs();
        bool executeRead(Buffer<FactoryParameters>& requests);
        bool executeWrite(Buffer<FactoryParameters>& requests);
        const Buffer<FactoryParameters>& lastRequests() const { return m_last_request; };
        void stopThread() override;
        void setExceptionHandler(const std::function<void(const Exception&)>& exception_handler)
        {
            m_exception_handler = exception_handler;
        }
        void setFinishedCallback(const std::function<void(bool success)>& finished_callback)
        {
            m_finished_callback = finished_callback;
        }
        bool readFile(FactoryParameters& file);
        bool writeFile(FactoryParameters& file);
        bool isAccepted() const {return m_is_accepted;}
        void accept();
        void cancel();
        void reset();
        ModelFactory* factory() const { return m_factory; };
    private:
        volatile bool m_is_canceled = false;
        volatile bool m_is_accepted = false;
        volatile bool m_options_changed = false;
        bool is_updating;
        volatile bool m_is_read;
        Buffer<FactoryParameters> m_next_request;//Thread safe
        Buffer<FactoryParameters> m_current_request;//Not Thread Safe
        Buffer<FactoryParameters> m_last_request;//Thread Safe
        Buffer<std::pair<File, File>> m_temp_files;
        ModelFactory* m_factory;
        mutable std::mutex m_critical_section;//critical section for this object only
        std::function<void(const Exception& e)> m_exception_handler;
        std::function<void(bool success)> m_finished_callback;
    };
}
#endif