quota.h revision 40f53fa8d9c6a4fc38c0014495e7a42b08f52481
/*
* Copyright (C) 2000 Internet Software Consortium.
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
* DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
* INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
* INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
* WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
/* $Id: quota.h,v 1.7 2000/08/01 01:30:36 tale Exp $ */
#ifndef ISC_QUOTA_H
#define ISC_QUOTA_H 1
/*****
***** Module Info
*****/
/*
* Quota
*
* The isc_quota_t object is a simple helper object for implementing
* quotas on things like the number of simultaneous connections to
* a server. It keeps track of the amount of quota in use, and
* encapsulates the locking necessary to allow multiple tasks to
* share a quota.
*/
/***
*** Imports.
***/
/*****
***** Types.
*****/
struct isc_quota {
/* Locked by lock. */
int max;
int used;
};
/*
* Initialize a quota object.
*
* Returns:
* ISC_R_SUCCESS
* Other error Lock creation failed.
*/
void
/*
* Destroy a quota object.
*/
/*
* Attempt to reserve one unit of 'quota'.
*
* Returns:
* ISC_R_SUCCESS Success
* ISC_R_QUOTA Quota is full
*/
void
/*
* Release one unit of quota.
*/
/*
* Like isc_quota_reserve, and also attaches '*p' to the
* quota if successful.
*/
void
isc_quota_detach(isc_quota_t **p);
/*
* Like isc_quota_release, and also detaches '*p' from the
* quota.
*/
#endif /* ISC_QUOTA_H */