1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
/*************************************************************************
* Copyright (C) 2009-2014 Tavian Barnes <tavianator@tavianator.com> *
* *
* This file is part of The Dimension Library. *
* *
* The Dimension Library is free software; you can redistribute it and/ *
* or modify it under the terms of the GNU Lesser General Public License *
* as published by the Free Software Foundation; either version 3 of the *
* License, or (at your option) any later version. *
* *
* The Dimension Library is distributed in the hope that it will be *
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty *
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this program. If not, see *
* <http://www.gnu.org/licenses/>. *
*************************************************************************/
/**
* @file
* An interface for asynchronous tasks. *_async() versions of functions
* return a dmnsn_future* object which can indicate the progress of the
* background task, and wait for task completion. The task's return value
* is returned as an int from dmnsn_finish_progress().
*/
#ifndef DMNSN_CONCURRENCY_H
#error "Please include <dimension/concurrency.h> instead of this header directly."
#endif
#include <stdbool.h>
/** A future object. */
typedef struct dmnsn_future dmnsn_future;
/**
* Join the worker thread and return its integer return value in addition to
* deleting \p future.
* @param[in,out] future The background task to join.
* @return The return value of the background task.
*/
int dmnsn_future_join(dmnsn_future *future);
/**
* Interrupt the execution of a background thread.
* @param[in,out] future The background task to cancel.
*/
void dmnsn_future_cancel(dmnsn_future *future);
/**
* Get the progress of the background task.
* @param[in] future The background task to examine.
* @return The progress of the background task, in [0.0, 1.0].
*/
double dmnsn_future_progress(const dmnsn_future *future);
/**
* Find out if a background task is finished.
* @param[in] future The background task to examine.
* @return true if the task is done, false otherwise.
*/
bool dmnsn_future_is_done(const dmnsn_future *future);
/**
* Wait for a certain amount of progress. Always use this rather than
* spinlocking.
* @param[in] future The background task to monitor.
* @param[in] progress The progress value to wait for.
*/
void dmnsn_future_wait(const dmnsn_future *future, double progress);
/**
* Pause all threads working on the given future. Once this function returns,
* it is safe to examine the intermediate state of the asynchronous computation.
* @param[in,out] future The background task to pause.
*/
void dmnsn_future_pause(dmnsn_future *future);
/**
* Resume a previously paused future object.
* @param[in,out] future The background task to resume.
*/
void dmnsn_future_resume(dmnsn_future *future);
|
