001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.async;
018
019import java.util.concurrent.BlockingQueue;
020
021import com.conversantmedia.util.concurrent.DisruptorBlockingQueue;
022import com.conversantmedia.util.concurrent.SpinPolicy;
023import org.apache.logging.log4j.core.config.Node;
024import org.apache.logging.log4j.core.config.plugins.Plugin;
025import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
026import org.apache.logging.log4j.core.config.plugins.PluginFactory;
027
028/**
029 * Factory for creating instances of {@link DisruptorBlockingQueue}.
030 *
031 * @since 2.7
032 */
033@Plugin(name = "DisruptorBlockingQueue", category = Node.CATEGORY, elementType = BlockingQueueFactory.ELEMENT_TYPE)
034public class DisruptorBlockingQueueFactory<E> implements BlockingQueueFactory<E> {
035
036    private final SpinPolicy spinPolicy;
037
038    private DisruptorBlockingQueueFactory(final SpinPolicy spinPolicy) {
039        this.spinPolicy = spinPolicy;
040    }
041
042    @Override
043    public BlockingQueue<E> create(final int capacity) {
044        return new DisruptorBlockingQueue<>(capacity, spinPolicy);
045    }
046
047    @PluginFactory
048    public static <E> DisruptorBlockingQueueFactory<E> createFactory(
049        @PluginAttribute(value = "SpinPolicy", defaultString = "WAITING") final SpinPolicy spinPolicy
050    ) {
051        return new DisruptorBlockingQueueFactory<>(spinPolicy);
052    }
053}