com.yahoo.yolean.concurrent.ConcurrentResourcePool Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vespajlib Show documentation

Library for use in Java components of Vespa. Shared code which do not fit anywhere else.

There is a newer version: 8.409.18

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.yolean.concurrent;

import java.util.Iterator;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.function.Supplier;

/**
 * A pool of a resource. This create new instances of the resource on request until enough are created
 * to deliver a unique one to all threads needing one concurrently and then reuse those instances
 * in subsequent requests.
 *
 * @author baldersheim
 */
public class ConcurrentResourcePool implements Iterable {

    private final Queue pool = new ConcurrentLinkedQueue<>();
    private final Supplier factory;


    public ConcurrentResourcePool(Supplier factory) {
        this.factory = factory;
    }

    public void preallocate(int instances) {
        for (int i = 0; i < instances; i++) {
            pool.offer(factory.get());
        }
    }

    /**
     * Allocates an instance of the resource to the requestor.
     * The resource will be allocated exclusively to the requestor until it calls free(instance).
     *
     * @return a reused or newly created instance of the resource
     */
    public final T alloc() {
        T e = pool.poll();
        return e != null ? e : factory.get();
    }

    /** Frees an instance previously acquired bty alloc */
    public final void free(T e) {
        pool.offer(e);
    }

    @Override
    public Iterator iterator() {
        return pool.iterator();
    }

}