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/future-impl.h | 54 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 libdimension/future-impl.h (limited to 'libdimension/future-impl.h') diff --git a/libdimension/future-impl.h b/libdimension/future-impl.h new file mode 100644 index 0000000..c25a7c2 --- /dev/null +++ b/libdimension/future-impl.h @@ -0,0 +1,54 @@ +/************************************************************************* + * Copyright (C) 2010-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 + * Future object implementation. + */ + +#include + +/** Allocate a new future object. */ +DMNSN_INTERNAL dmnsn_future *dmnsn_new_future(void); + +/** Set the total number of loop iterations. */ +DMNSN_INTERNAL void dmnsn_future_set_total(dmnsn_future *future, size_t total); +/** Increment the progress of a background task. */ +DMNSN_INTERNAL void dmnsn_future_increment(dmnsn_future *future); +/** Instantly complete the background teask. */ +DMNSN_INTERNAL void dmnsn_future_done(dmnsn_future *future); + +struct dmnsn_future { + size_t progress; /**< Completed loop iterations. */ + size_t total; /**< Total expected loop iterations. */ + + /** The worker thread. */ + pthread_t thread; + + /** Read-write synchronization. */ + pthread_rwlock_t *rwlock; + + /** Condition variable for waiting for a particular amount of progress. */ + pthread_cond_t *cond; + pthread_mutex_t *mutex; + + /** Minimum waited-on value. */ + double *min_wait; +}; -- cgit v1.2.3