maddy

 1/*
 2Maddy Mail Server - Composable all-in-one email server.
 3Copyright © 2019-2020 Max Mazurov <fox.cpp@disroot.org>, Maddy Mail Server contributors
 4
 5This program is free software: you can redistribute it and/or modify
 6it under the terms of the GNU General Public License as published by
 7the Free Software Foundation, either version 3 of the License, or
 8(at your option) any later version.
 9
10This program is distributed in the hope that it will be useful,
11but WITHOUT ANY WARRANTY; without even the implied warranty of
12MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13GNU General Public License for more details.
14
15You should have received a copy of the GNU General Public License
16along with this program.  If not, see <https://www.gnu.org/licenses/>.
17*/
18
19// Package limiters provides a set of wrappers intended to restrict the amount
20// of resources consumed by the server.
21package limiters
22
23import "context"
24
25// The L interface represents a blocking limiter that has some upper bound of
26// resource use and blocks when it is exceeded until enough resources are
27// freed.
28type L interface {
29	Take() bool
30	TakeContext(context.Context) error
31	Release()
32
33	// Close frees any resources used internally by Limiter for book-keeping.
34	Close()
35}