contrib/bind-9.5.2/lib/isc/include/isc/mutexblock.h

   1 /*
   2  * Copyright (C) 2004-2007  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1999-2001  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and/or 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.17 2007/06/19 23:47:18 tbox Exp $ */
  19
  20 #ifndef ISC_MUTEXBLOCK_H
  21 #define ISC_MUTEXBLOCK_H 1
  22
  23 /*! \file isc/mutexblock.h */
  24
  25 #include <isc/lang.h>
  26 #include <isc/mutex.h>
  27 #include <isc/types.h>
  28
  29 ISC_LANG_BEGINDECLS
  30
  31 isc_result_t
  32 isc_mutexblock_init(isc_mutex_t *block, unsigned int count);
  33 /*%<
  34  * Initialize a block of locks.  If an error occurs all initialized locks
  35  * will be destroyed, if possible.
  36  *
  37  * Requires:
  38  *
  39  *\li   block != NULL
  40  *
  41  *\li   count > 0
  42  *
  43  * Returns:
  44  *
  45  *\li   Any code isc_mutex_init() can return is a valid return for this
  46  *      function.
  47  */
  48
  49 isc_result_t
  50 isc_mutexblock_destroy(isc_mutex_t *block, unsigned int count);
  51 /*%<
  52  * Destroy a block of locks.
  53  *
  54  * Requires:
  55  *
  56  *\li   block != NULL
  57  *
  58  *\li   count > 0
  59  *
  60  *\li   Each lock in the block be initialized via isc_mutex_init() or
  61  *      the whole block was initialized via isc_mutex_initblock().
  62  *
  63  * Returns:
  64  *
  65  *\li   Any code isc_mutex_init() can return is a valid return for this
  66  *      function.
  67  */
  68
  69 ISC_LANG_ENDDECLS
  70
  71 #endif /* ISC_MUTEXBLOCK_H */