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/progress.h | 59 --------------------------------------- 1 file changed, 59 deletions(-) delete mode 100644 libdimension/dimension/progress.h (limited to 'libdimension/dimension/progress.h') diff --git a/libdimension/dimension/progress.h b/libdimension/dimension/progress.h deleted file mode 100644 index 3464a9b..0000000 --- a/libdimension/dimension/progress.h +++ /dev/null @@ -1,59 +0,0 @@ -/************************************************************************* - * 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_progress* 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 progress object. */ -typedef struct dmnsn_progress dmnsn_progress; - -/** - * Join the worker thread and return it's integer return value in addition to - * deleting \p progress. - * @param[in,out] progress The background task to finish. - * @return The return value of the background task. - */ -int dmnsn_finish_progress(dmnsn_progress *progress); - -/** - * Interrupt the execution of a background thread. - * @param[in,out] progress The background task to cancel. - */ -void dmnsn_cancel_progress(dmnsn_progress *progress); - -/** - * Get the progress of the background task. - * @param[in] progress The background task to examine. - * @return The progress of the background task, out of 1.0. - */ -double dmnsn_get_progress(const dmnsn_progress *progress); - -/** - * Wait for a certain amount of progress. Always use this rather than - * spinlocking. - * @param[in] progress The background task to monitor. - * @param[in] prog The progress value to wait for. - */ -void dmnsn_wait_progress(const dmnsn_progress *progress, double prog); -- cgit v1.2.3