blob: 20f7f28e64bf6623e2582ca17bd816d2a658b670 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Package org.apache.logging.log4j.core.async (Apache Log4j Core 2.23.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="use: package: org.apache.logging.log4j.core.async">
<meta name="generator" content="javadoc/PackageUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="package-use-page">
<script type="text/javascript">var pathtoroot = "../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="nav-bar-cell1-rev">Use</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Uses of Package org.apache.logging.log4j.core.async" class="title">Uses of Package<br>org.apache.logging.log4j.core.async</h1>
</div>
<div class="caption"><span>Packages that use <a href="package-summary.html">org.apache.logging.log4j.core.async</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender</a></div>
<div class="col-last even-row-color">
<div class="block">Log4j 2 Appenders.</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.logging.log4j.core.async">org.apache.logging.log4j.core.async</a></div>
<div class="col-last odd-row-color">
<div class="block">Provides Asynchronous Logger classes and interfaces for low-latency logging.</div>
</div>
<div class="col-first even-row-color"><a href="#org.apache.logging.log4j.core.config">org.apache.logging.log4j.core.config</a></div>
<div class="col-last even-row-color">
<div class="block">Configuration of Log4j 2.</div>
</div>
</div>
<section class="package-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.logging.log4j.core.appender">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.core.async</a> used by <a href="../appender/package-summary.html">org.apache.logging.log4j.core.appender</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/BlockingQueueFactory.html#org.apache.logging.log4j.core.appender">BlockingQueueFactory</a></div>
<div class="col-last even-row-color">
<div class="block">Factory for creating instances of <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/BlockingQueue.html" title="class or interface in java.util.concurrent" class="external-link"><code>BlockingQueue</code></a>.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.core.async">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.core.async</a> used by <a href="package-summary.html">org.apache.logging.log4j.core.async</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/ArrayBlockingQueueFactory.html#org.apache.logging.log4j.core.async">ArrayBlockingQueueFactory</a></div>
<div class="col-last even-row-color">
<div class="block">Factory for creating instances of <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ArrayBlockingQueue.html" title="class or interface in java.util.concurrent" class="external-link"><code>ArrayBlockingQueue</code></a>.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/AsyncLogger.html#org.apache.logging.log4j.core.async">AsyncLogger</a></div>
<div class="col-last odd-row-color">
<div class="block">AsyncLogger is a logger designed for high throughput and low latency logging.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/AsyncLoggerConfig.html#org.apache.logging.log4j.core.async">AsyncLoggerConfig</a></div>
<div class="col-last even-row-color">
<div class="block">Asynchronous Logger object that is created via configuration and can be
combined with synchronous loggers.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/AsyncLoggerConfig.Builder.html#org.apache.logging.log4j.core.async">AsyncLoggerConfig.Builder</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="class-use/AsyncLoggerConfig.RootLogger.Builder.html#org.apache.logging.log4j.core.async">AsyncLoggerConfig.RootLogger.Builder</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="class-use/AsyncLoggerConfigDelegate.html#org.apache.logging.log4j.core.async">AsyncLoggerConfigDelegate</a></div>
<div class="col-last odd-row-color">
<div class="block">Encapsulates the mechanism used to log asynchronously.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/AsyncQueueFullPolicy.html#org.apache.logging.log4j.core.async">AsyncQueueFullPolicy</a></div>
<div class="col-last even-row-color">
<div class="block">Policy for deciding whether to discard the event, enqueue it or log the event on the current thread when the queue
is full.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/AsyncWaitStrategyFactory.html#org.apache.logging.log4j.core.async">AsyncWaitStrategyFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">This interface allows users to configure a custom Disruptor WaitStrategy used for
Async Loggers and Async LoggerConfigs.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/AsyncWaitStrategyFactoryConfig.html#org.apache.logging.log4j.core.async">AsyncWaitStrategyFactoryConfig</a></div>
<div class="col-last even-row-color">
<div class="block">This class allows users to configure the factory used to create
an instance of the LMAX disruptor WaitStrategy
used by Async Loggers in the log4j configuration.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/AsyncWaitStrategyFactoryConfig.Builder.html#org.apache.logging.log4j.core.async">AsyncWaitStrategyFactoryConfig.Builder</a></div>
<div class="col-last odd-row-color">
<div class="block">Builds AsyncWaitStrategyFactoryConfig instances.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/BlockingQueueFactory.html#org.apache.logging.log4j.core.async">BlockingQueueFactory</a></div>
<div class="col-last even-row-color">
<div class="block">Factory for creating instances of <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/BlockingQueue.html" title="class or interface in java.util.concurrent" class="external-link"><code>BlockingQueue</code></a>.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/DefaultAsyncQueueFullPolicy.html#org.apache.logging.log4j.core.async">DefaultAsyncQueueFullPolicy</a></div>
<div class="col-last odd-row-color">
<div class="block">Default router: enqueue the event for asynchronous logging in the background thread, unless the current thread is the
background thread and the queue is full (enqueueing would cause a deadlock).</div>
</div>
<div class="col-first even-row-color"><a href="class-use/DisruptorBlockingQueueFactory.html#org.apache.logging.log4j.core.async">DisruptorBlockingQueueFactory</a></div>
<div class="col-last even-row-color">
<div class="block">Factory for creating instances of <code>DisruptorBlockingQueue</code>.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/EventRoute.html#org.apache.logging.log4j.core.async">EventRoute</a></div>
<div class="col-last odd-row-color">
<div class="block">Enumeration over the different destinations where a log event can be sent.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/JCToolsBlockingQueueFactory.html#org.apache.logging.log4j.core.async">JCToolsBlockingQueueFactory</a></div>
<div class="col-last even-row-color">
<div class="block">Factory for creating instances of BlockingQueues backed by JCTools <code>MpscArrayQueue</code>.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/JCToolsBlockingQueueFactory.WaitStrategy.html#org.apache.logging.log4j.core.async">JCToolsBlockingQueueFactory.WaitStrategy</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="class-use/LinkedTransferQueueFactory.html#org.apache.logging.log4j.core.async">LinkedTransferQueueFactory</a></div>
<div class="col-last even-row-color">
<div class="block">Factory for creating instances of <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/LinkedTransferQueue.html" title="class or interface in java.util.concurrent" class="external-link"><code>LinkedTransferQueue</code></a>.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/RingBufferLogEvent.html#org.apache.logging.log4j.core.async">RingBufferLogEvent</a></div>
<div class="col-last odd-row-color">
<div class="block">When the Disruptor is started, the RingBuffer is populated with event objects.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/ThreadNameCachingStrategy.html#org.apache.logging.log4j.core.async">ThreadNameCachingStrategy</a></div>
<div class="col-last even-row-color">
<div class="block">Strategy for deciding whether thread name should be cached or not.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.core.config">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.logging.log4j.core.async</a> used by <a href="../config/package-summary.html">org.apache.logging.log4j.core.config</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/AsyncLoggerConfigDelegate.html#org.apache.logging.log4j.core.config">AsyncLoggerConfigDelegate</a></div>
<div class="col-last even-row-color">
<div class="block">Encapsulates the mechanism used to log asynchronously.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/AsyncWaitStrategyFactory.html#org.apache.logging.log4j.core.config">AsyncWaitStrategyFactory</a></div>
<div class="col-last odd-row-color">
<div class="block">This interface allows users to configure a custom Disruptor WaitStrategy used for
Async Loggers and Async LoggerConfigs.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p>
</footer>
</div>
</div>
</body>
</html>