/*

[0] Fix | Delete

* Copyright (C) Internet Systems Consortium, Inc. ("ISC")

[1] Fix | Delete

*

[2] Fix | Delete

* This Source Code Form is subject to the terms of the Mozilla Public

[3] Fix | Delete

* License, v. 2.0. If a copy of the MPL was not distributed with this

[4] Fix | Delete

* file, you can obtain one at https://mozilla.org/MPL/2.0/.

[5] Fix | Delete

*

[6] Fix | Delete

* See the COPYRIGHT file distributed with this work for additional

[7] Fix | Delete

* information regarding copyright ownership.

[8] Fix | Delete

*/

[9] Fix | Delete

[10] Fix | Delete

[11] Fix | Delete

#ifndef ISC_MUTEXBLOCK_H

[12] Fix | Delete

#define ISC_MUTEXBLOCK_H 1

[13] Fix | Delete

[14] Fix | Delete

/*! \file isc/mutexblock.h */

[15] Fix | Delete

[16] Fix | Delete

#include <isc/lang.h>

[17] Fix | Delete

#include <isc/mutex.h>

[18] Fix | Delete

#include <isc/types.h>

[19] Fix | Delete

[20] Fix | Delete

ISC_LANG_BEGINDECLS

[21] Fix | Delete

[22] Fix | Delete

isc_result_t

[23] Fix | Delete

isc_mutexblock_init(isc_mutex_t *block, unsigned int count);

[24] Fix | Delete

/*%<

[25] Fix | Delete

* Initialize a block of locks. If an error occurs all initialized locks

[26] Fix | Delete

* will be destroyed, if possible.

[27] Fix | Delete

*

[28] Fix | Delete

* Requires:

[29] Fix | Delete

*

[30] Fix | Delete

*\li block != NULL

[31] Fix | Delete

*

[32] Fix | Delete

*\li count > 0

[33] Fix | Delete

*

[34] Fix | Delete

* Returns:

[35] Fix | Delete

*

[36] Fix | Delete

*\li Any code isc_mutex_init() can return is a valid return for this

[37] Fix | Delete

* function.

[38] Fix | Delete

*/

[39] Fix | Delete

[40] Fix | Delete

isc_result_t

[41] Fix | Delete

isc_mutexblock_destroy(isc_mutex_t *block, unsigned int count);

[42] Fix | Delete

/*%<

[43] Fix | Delete

* Destroy a block of locks.

[44] Fix | Delete

*

[45] Fix | Delete

* Requires:

[46] Fix | Delete

*

[47] Fix | Delete

*\li block != NULL

[48] Fix | Delete

*

[49] Fix | Delete

*\li count > 0

[50] Fix | Delete

*

[51] Fix | Delete

*\li Each lock in the block be initialized via isc_mutex_init() or

[52] Fix | Delete

* the whole block was initialized via isc_mutex_initblock().

[53] Fix | Delete

*

[54] Fix | Delete

* Returns:

[55] Fix | Delete

*

[56] Fix | Delete

*\li Any code isc_mutex_init() can return is a valid return for this

[57] Fix | Delete

* function.

[58] Fix | Delete

*/

[59] Fix | Delete

[60] Fix | Delete

ISC_LANG_ENDDECLS

[61] Fix | Delete

[62] Fix | Delete

#endif /* ISC_MUTEXBLOCK_H */

[63] Fix | Delete

[64] Fix | Delete