Job.h

/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

class CJob;

#include <stddef.h>

#define kJobTypeMediaFlags  "mediaflags"
#define kJobTypeCacheImage  "cacheimage"
#define kJobTypeDDSCompress "ddscompress"

class IJobCallback
{
public:
  virtual ~IJobCallback() = default;

  virtual void OnJobComplete(unsigned int jobID, bool success, CJob *job)=0;

  virtual void OnJobAbort(unsigned int jobID, CJob* job) {}

  virtual void OnJobProgress(unsigned int jobID,
                             unsigned int progress,
                             unsigned int total,
                             const CJob* job)
  {
  }
};

class CJobManager;

class CJob
{
public:
  enum PRIORITY {
    PRIORITY_LOW_PAUSABLE = 0,
    PRIORITY_LOW,
    PRIORITY_NORMAL,
    PRIORITY_HIGH,
    PRIORITY_DEDICATED, // will create a new worker if no worker is available at queue time
  };
  CJob() { m_callback = NULL; }

  virtual ~CJob() = default;

  virtual bool DoWork() = 0;  // function to do the work

  virtual const char* GetType() const { return ""; }

  virtual bool operator==(const CJob* job) const
  {
    return false;
  }

  virtual bool ShouldCancel(unsigned int progress, unsigned int total) const;
private:
  friend class CJobManager;
  CJobManager *m_callback;
};