61 lines
1.9 KiB
C
61 lines
1.9 KiB
C
/*
|
|
* Declarations for background jobs
|
|
*
|
|
* Copyright (c) 2011 IBM Corp.
|
|
* Copyright (c) 2012, 2018 Red Hat, Inc.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef JOB_H
|
|
#define JOB_H
|
|
|
|
typedef struct JobDriver JobDriver;
|
|
|
|
/**
|
|
* Long-running operation.
|
|
*/
|
|
typedef struct Job {
|
|
/** The ID of the job. May be NULL for internal jobs. */
|
|
char *id;
|
|
|
|
/** The type of this job. */
|
|
const JobDriver *driver;
|
|
} Job;
|
|
|
|
/**
|
|
* Callbacks and other information about a Job driver.
|
|
*/
|
|
struct JobDriver {
|
|
/** Derived Job struct size */
|
|
size_t instance_size;
|
|
};
|
|
|
|
|
|
/**
|
|
* Create a new long-running job and return it.
|
|
*
|
|
* @job_id: The id of the newly-created job, or %NULL for internal jobs
|
|
* @driver: The class object for the newly-created job.
|
|
* @errp: Error object.
|
|
*/
|
|
void *job_create(const char *job_id, const JobDriver *driver, Error **errp);
|
|
|
|
#endif
|