From e9810a7b1aae15320e58371b657a2f963562834d Mon Sep 17 00:00:00 2001 From: Tavian Barnes Date: Wed, 19 Oct 2011 12:37:32 -0400 Subject: Rename progress objects to future objects. --- libdimension/dimension/future.h | 59 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 libdimension/dimension/future.h (limited to 'libdimension/dimension/future.h') diff --git a/libdimension/dimension/future.h b/libdimension/dimension/future.h new file mode 100644 index 0000000..f0693b9 --- /dev/null +++ b/libdimension/dimension/future.h @@ -0,0 +1,59 @@ +/************************************************************************* + * Copyright (C) 2009-2011 Tavian Barnes * + * * + * 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 * + * . * + *************************************************************************/ + +/** + * @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(). + */ + +/** 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); + +/** + * 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); -- cgit v1.2.3