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 org.apache.logging.log4j.Level;
020
021/**
022 * Policy for deciding whether to discard the event, enqueue it or log the event on the current thread when the queue
023 * is full.
024 *
025 * @see AsyncQueueFullPolicyFactory
026 * @since 2.6
027 */
028public interface AsyncQueueFullPolicy {
029
030    /**
031     * Returns the appropriate route for the current log event, given the specified parameters.
032     *
033     * @param backgroundThreadId the thread ID of the background thread. Can be compared with the current thread's ID.
034     * @param level the level of the log event
035     * @return the appropriate route for the current event
036     */
037    EventRoute getRoute(final long backgroundThreadId, final Level level);
038}