input/semaphore.go

// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you 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 input

import "context"

// Semaphore is used by inputs to limit the number of concurrent requests
type Semaphore interface {
	// Acquire acquires the semaphore with a weight of n, blocking until
	// resources are available or ctx is done. On success, returns nil. On
	// failure, returns ctx.Err() and leaves the semaphore unchanged.
	Acquire(context.Context, int64) error
	// TryAcquire acquires the semaphore with a weight of n without blocking. On
	// success, returns true. On failure, returns false and leaves the semaphore
	// unchanged.
	TryAcquire(int64) bool
	// Release releases the semaphore with a weight of n.
	Release(int64)
}