org.agrona.concurrent.BusySpinIdleStrategy Maven / Gradle / Ivy

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

High performance primitives and utility library.

There is a newer version: 0.9.1

/*
 *  Copyright 2014 - 2016 Real Logic Ltd.
 *
 * 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 org.agrona.concurrent;

import org.agrona.hints.ThreadHints;

/**
 * Busy spin strategy targeted at lowest possible latency. This strategy will monopolise a thread to achieve the lowest
 * possible latency. Useful for creating bubbles in the execution pipeline of tight busy spin loops with no other logic than
 * status checks on progress.
 */
public final class BusySpinIdleStrategy implements IdleStrategy
{
    /**
     * Note: this implementation will result in no safepoint poll once inlined.
     *
     * @see org.agrona.concurrent.IdleStrategy#idle(int)
     */
    public void idle(final int workCount)
    {
        if (workCount > 0)
        {
            return;
        }

        idle();
    }

    public void idle()
    {
        ThreadHints.onSpinWait();
    }

    public void reset()
    {
    }
}