contrib/bind-9.2.4rc7/lib/isc/include/isc/mutexblock.h

   1 /*
   2  * Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1999-2001  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id: mutexblock.h,v 1.10.2.1 2004/03/09 06:11:58 marka Exp $ */
  19
  20 #ifndef ISC_MUTEXBLOCK_H
  21 #define ISC_MUTEXBLOCK_H 1
  22
  23 #include <isc/lang.h>
  24 #include <isc/mutex.h>
  25 #include <isc/types.h>
  26
  27 ISC_LANG_BEGINDECLS
  28
  29 isc_result_t
  30 isc_mutexblock_init(isc_mutex_t *block, unsigned int count);
  31 /*
  32  * Initialize a block of locks.  If an error occurs all initialized locks
  33  * will be destroyed, if possible.
  34  *
  35  * Requires:
  36  *
  37  *      block != NULL
  38  *
  39  *      count > 0
  40  *
  41  * Returns:
  42  *
  43  *      Any code isc_mutex_init() can return is a valid return for this
  44  *      function.
  45  */
  46
  47 isc_result_t
  48 isc_mutexblock_destroy(isc_mutex_t *block, unsigned int count);
  49 /*
  50  * Destroy a block of locks.
  51  *
  52  * Requires:
  53  *
  54  *      block != NULL
  55  *
  56  *      count > 0
  57  *
  58  *      Each lock in the block be initialized via isc_mutex_init() or
  59  *      the whole block was initialized via isc_mutex_initblock().
  60  *
  61  * Returns:
  62  *
  63  *      Any code isc_mutex_init() can return is a valid return for this
  64  *      function.
  65  */
  66
  67 ISC_LANG_ENDDECLS
  68
  69 #endif /* ISC_MUTEXBLOCK_H */