00001 /* 00002 * Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC") 00003 * Copyright (C) 1999-2001 Internet Software Consortium. 00004 * 00005 * Permission to use, copy, modify, and/or distribute this software for any 00006 * purpose with or without fee is hereby granted, provided that the above 00007 * copyright notice and this permission notice appear in all copies. 00008 * 00009 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 00010 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 00011 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 00012 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 00013 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 00014 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 00015 * PERFORMANCE OF THIS SOFTWARE. 00016 */ 00017 00018 /* $Id: mutexblock.h,v 1.17 2007/06/19 23:47:18 tbox Exp $ */ 00019 00020 #ifndef ISC_MUTEXBLOCK_H 00021 #define ISC_MUTEXBLOCK_H 1 00022 00023 /*! \file isc/mutexblock.h */ 00024 00025 #include <isc/lang.h> 00026 #include <isc/mutex.h> 00027 #include <isc/types.h> 00028 00029 ISC_LANG_BEGINDECLS 00030 00031 isc_result_t 00032 isc_mutexblock_init(isc_mutex_t *block, unsigned int count); 00033 /*%< 00034 * Initialize a block of locks. If an error occurs all initialized locks 00035 * will be destroyed, if possible. 00036 * 00037 * Requires: 00038 * 00039 *\li block != NULL 00040 * 00041 *\li count > 0 00042 * 00043 * Returns: 00044 * 00045 *\li Any code isc_mutex_init() can return is a valid return for this 00046 * function. 00047 */ 00048 00049 isc_result_t 00050 isc_mutexblock_destroy(isc_mutex_t *block, unsigned int count); 00051 /*%< 00052 * Destroy a block of locks. 00053 * 00054 * Requires: 00055 * 00056 *\li block != NULL 00057 * 00058 *\li count > 0 00059 * 00060 *\li Each lock in the block be initialized via isc_mutex_init() or 00061 * the whole block was initialized via isc_mutex_initblock(). 00062 * 00063 * Returns: 00064 * 00065 *\li Any code isc_mutex_init() can return is a valid return for this 00066 * function. 00067 */ 00068 00069 ISC_LANG_ENDDECLS 00070 00071 #endif /* ISC_MUTEXBLOCK_H */