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 org.apache.logging.log4j.Level;
20  
21  /**
22   * Policy for deciding whether to discard the event, enqueue it or log the event on the current thread when the queue
23   * is full.
24   *
25   * @see AsyncQueueFullPolicyFactory
26   * @since 2.6
27   */
28  public interface AsyncQueueFullPolicy {
29  
30      /**
31       * Returns the appropriate route for the current log event, given the specified parameters.
32       *
33       * @param backgroundThreadId the thread ID of the background thread. Can be compared with the current thread's ID.
34       * @param level the level of the log event
35       * @return the appropriate route for the current event
36       */
37      EventRoute getRoute(final long backgroundThreadId, final Level level);
38  }