TimerBasedTaskExecution.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#pragma once
 
#include <vcl/timer.hxx>
 
#include <memory>
 
namespace sd::tools {
 
class AsynchronousTask;
 
class TimerBasedTaskExecution
{
public:
    static std::shared_ptr<TimerBasedTaskExecution> Create (
        const std::shared_ptr<AsynchronousTask>& rpTask,
        sal_uInt32 nMillisecondsBetweenSteps,
        sal_uInt32 nMaxTimePerStep);
 
    void Release();
 
    static void ReleaseTask (const std::weak_ptr<TimerBasedTaskExecution>& rpTask);
 
private:
    std::shared_ptr<AsynchronousTask> mpTask;
    Timer maTimer;
    std::shared_ptr<TimerBasedTaskExecution> mpSelf;
    sal_uInt32 mnMaxTimePerStep;
 
    TimerBasedTaskExecution (
        std::shared_ptr<AsynchronousTask> pTask,
        sal_uInt32 nMillisecondsBetweenSteps,
        sal_uInt32 nMaxTimePerStep);
    ~TimerBasedTaskExecution();
 
    class Deleter;
    friend class Deleter;
 
    DECL_LINK(TimerCallback, Timer *, void);
};
 
} // end of namespace ::sd::tools
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */