xbmc/video/jobs/VideoLibraryJob.h

   1 /*
   2  *  Copyright (C) 2014-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include "utils/Job.h"
  12
  13 class CVideoDatabase;
  14
  15 /*!
  16  \brief Basic implementation/interface of a CJob which interacts with the
  17  video database.
  18  */
  19 class CVideoLibraryJob : public CJob
  20 {
  21 public:
  22   ~CVideoLibraryJob() override;
  23
  24   /*!
  25    \brief Whether the job can be cancelled or not.
  26    */
  27   virtual bool CanBeCancelled() const { return false; }
  28
  29   /*!
  30    \brief Tries to cancel the running job.
  31
  32    \return True if the job was cancelled, false otherwise
  33   */
  34   virtual bool Cancel() { return false; }
  35
  36   // implementation of CJob
  37   bool DoWork() override;
  38   const char *GetType() const override { return "VideoLibraryJob"; }
  39   bool operator==(const CJob* job) const override { return false; }
  40
  41 protected:
  42   CVideoLibraryJob();
  43
  44   /*!
  45    \brief Worker method to be implemented by an actual implementation.
  46
  47    \param[in] db Already open video database to be used for interaction
  48    \return True if the process succeeded, false otherwise
  49    */
  50   virtual bool Work(CVideoDatabase &db) = 0;
  51 };