/*
Copyright 2023 The Dapr Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package ratelimiting

import "context"

// RateLimiter is the interface for rate limiting events.
type RateLimiter interface {
	// Run starts the rate limiter. The given channel will have events sent to
	// it, according to the rate limited parameters.
	Run(ctx context.Context, eventCh chan<- struct{}) error

	// Add adds a new event to the rate limiter.
	Add()

	// Close closes the rate limiter and waits for all resources to be released.
	Close()
}
