Swiftray  1.0
BaseJob Class Reference

A class template for connection senders, we opensource this part to allow inserting GPL-licensed middleware. More...

#include <base-job.h>

Inheritance diagram for BaseJob:
SerialJob

Public Types

enum class  Status {
  READY , STARTING , RUNNING , PAUSED ,
  PAUSING , RESUMING , FINISHED , ERROR_STOPPED ,
  ERROR_PAUSED
}
 

Signals

void error (const QString &error_message)
 
void timeout (const QString &s)
 

Public Member Functions

 BaseJob (QObject *parent, QString endpoint, QVariant data)
 
 ~BaseJob ()
 
virtual void pause ()
 
virtual int progress ()
 
virtual void resume ()
 
virtual void start ()
 
Status status ()
 

Protected Member Functions

void setStatus (Status status)
 

Protected Attributes

QMutex mutex_
 
Status status_
 

Detailed Description

A class template for connection senders, we opensource this part to allow inserting GPL-licensed middleware.

Member Enumeration Documentation

◆ Status

enum BaseJob::Status
strong
Enumerator
READY 
STARTING 
RUNNING 
PAUSED 
PAUSING 
RESUMING 
FINISHED 
ERROR_STOPPED 
ERROR_PAUSED 

Constructor & Destructor Documentation

◆ BaseJob()

BaseJob::BaseJob ( QObject *  parent,
QString  endpoint,
QVariant  data 
)

◆ ~BaseJob()

BaseJob::~BaseJob ( )

Member Function Documentation

◆ error

void BaseJob::error ( const QString &  error_message)
signal

◆ pause()

void BaseJob::pause ( )
virtual

Reimplemented in SerialJob.

◆ progress()

int BaseJob::progress ( )
virtual

Reimplemented in SerialJob.

◆ resume()

void BaseJob::resume ( )
virtual

Reimplemented in SerialJob.

◆ setStatus()

void BaseJob::setStatus ( BaseJob::Status  status)
protected

◆ start()

void BaseJob::start ( )
virtual

Reimplemented in SerialJob.

◆ status()

BaseJob::Status BaseJob::status ( )

◆ timeout

void BaseJob::timeout ( const QString &  s)
signal

Member Data Documentation

◆ mutex_

QMutex BaseJob::mutex_
protected

◆ status_

Status BaseJob::status_
protected

The documentation for this class was generated from the following files: