include/vcl/idle.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_VCL_IDLE_HXX
  21 #define INCLUDED_VCL_IDLE_HXX
  22
  23 #include <vcl/timer.hxx>
  24
  25 /**
  26  * An idle is a timer to be scheduled immediately.
  27  *
  28  * It's - more or less - just a convenience class.
  29  *
  30  * Note: Despite the name, the timer is not necessarily invoked when idle.
  31  * Use an idle priority such as TaskPriority::DEFAULT_IDLE to actually
  32  * invoke the timer only when idle.
  33  */
  34 class VCL_DLLPUBLIC Idle : public Timer
  35 {
  36 private:
  37     // Delete all timeout specific functions, we don't want in an Idle
  38     void          SetTimeout( sal_uInt64 nTimeoutMs ) = delete;
  39     sal_uInt64    GetTimeout() const = delete;
  40
  41 protected:
  42     virtual sal_uInt64 UpdateMinPeriod( sal_uInt64 nTimeNow ) const override;
  43
  44     Idle( bool bAuto, const char *pDebugName );
  45
  46 public:
  47     Idle( const char *pDebugName );
  48
  49     virtual void Start(bool bStartTimer = true) override;
  50 };
  51
  52 /**
  53  * An auto-idle is long running task processing small chunks of data, which
  54  * is re-scheduled multiple times.
  55  *
  56  * Remember to stop the Idle when finished, as it would otherwise busy loop the CPU!
  57  *
  58  * It probably makes sense to re-implement ReadyForSchedule and UpdateMinPeriod,
  59  * in case there is a quick check and it can otherwise sleep.
  60  */
  61 class VCL_DLLPUBLIC AutoIdle : public Idle
  62 {
  63 public:
  64     AutoIdle( const char *pDebugName );
  65 };
  66
  67
  68 #endif // INCLUDED_VCL_IDLE_HXX
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */