View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core.async;
18  
19  import java.util.concurrent.BlockingQueue;
20  
21  import com.conversantmedia.util.concurrent.DisruptorBlockingQueue;
22  import com.conversantmedia.util.concurrent.SpinPolicy;
23  import org.apache.logging.log4j.core.config.Node;
24  import org.apache.logging.log4j.core.config.plugins.Plugin;
25  import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
26  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
27  
28  /**
29   * Factory for creating instances of {@link DisruptorBlockingQueue}.
30   *
31   * @since 2.7
32   */
33  @Plugin(name = "DisruptorBlockingQueue", category = Node.CATEGORY, elementType = BlockingQueueFactory.ELEMENT_TYPE)
34  public class DisruptorBlockingQueueFactory<E> implements BlockingQueueFactory<E> {
35  
36      private final SpinPolicy spinPolicy;
37  
38      private DisruptorBlockingQueueFactory(final SpinPolicy spinPolicy) {
39          this.spinPolicy = spinPolicy;
40      }
41  
42      @Override
43      public BlockingQueue<E> create(final int capacity) {
44          return new DisruptorBlockingQueue<>(capacity, spinPolicy);
45      }
46  
47      @PluginFactory
48      public static <E> DisruptorBlockingQueueFactory<E> createFactory(
49          @PluginAttribute(value = "SpinPolicy", defaultString = "WAITING") final SpinPolicy spinPolicy
50      ) {
51          return new DisruptorBlockingQueueFactory<>(spinPolicy);
52      }
53  }