2 * Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 2000, 2001 Internet Software Consortium.
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.
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.
18 /* $Id: quota.h,v 1.8.12.6 2005/08/11 15:00:08 marka Exp $ */
30 * The isc_quota_t object is a simple helper object for implementing
31 * quotas on things like the number of simultaneous connections to
32 * a server. It keeps track of the amount of quota in use, and
33 * encapsulates the locking necessary to allow multiple tasks to
42 #include <isc/mutex.h>
43 #include <isc/types.h>
60 isc_quota_init(isc_quota_t *quota, int max);
62 * Initialize a quota object.
66 * Other error Lock creation failed.
70 isc_quota_destroy(isc_quota_t *quota);
72 * Destroy a quota object.
76 isc_quota_soft(isc_quota_t *quota, int soft);
78 * Turn on/off soft quotas.
82 isc_quota_max(isc_quota_t *quota, int max);
84 * Re-set a maximum quota.
88 isc_quota_reserve(isc_quota_t *quota);
90 * Attempt to reserve one unit of 'quota'.
93 * ISC_R_SUCCESS Success
94 * ISC_R_SOFTQUOTA Success soft quota reached
95 * ISC_R_QUOTA Quota is full
99 isc_quota_release(isc_quota_t *quota);
101 * Release one unit of quota.
105 isc_quota_attach(isc_quota_t *quota, isc_quota_t **p);
107 * Like isc_quota_reserve, and also attaches '*p' to the
108 * quota if successful (ISC_R_SUCCESS or ISC_R_SOFTQUOTA).
112 isc_quota_detach(isc_quota_t **p);
114 * Like isc_quota_release, and also detaches '*p' from the
120 #endif /* ISC_QUOTA_H */