| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_144) on Sun May 10 12:47:47 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.logging.log4j.core.async (Apache Log4j Core 2.13.3 API)</title> |
| <meta name="date" content="2020-05-10"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.logging.log4j.core.async (Apache Log4j Core 2.13.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/appender/routing/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/config/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/async/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.logging.log4j.core.async</h1> |
| <div class="docSummary"> |
| <div class="block">Provides Asynchronous Logger classes and interfaces for low-latency logging.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html" title="interface in org.apache.logging.log4j.core.async">AsyncLoggerConfigDelegate</a></td> |
| <td class="colLast"> |
| <div class="block">Encapsulates the mechanism used to log asynchronously.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncQueueFullPolicy.html" title="interface in org.apache.logging.log4j.core.async">AsyncQueueFullPolicy</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/BlockingQueueFactory.html" title="interface in org.apache.logging.log4j.core.async">BlockingQueueFactory</a><E></td> |
| <td class="colLast"> |
| <div class="block">Factory for creating instances of <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/BlockingQueue.html?is-external=true" title="class or interface in java.util.concurrent"><code>BlockingQueue</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/ArrayBlockingQueueFactory.html" title="class in org.apache.logging.log4j.core.async">ArrayBlockingQueueFactory</a><E></td> |
| <td class="colLast"> |
| <div class="block">Factory for creating instances of <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ArrayBlockingQueue.html?is-external=true" title="class or interface in java.util.concurrent"><code>ArrayBlockingQueue</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLogger.html" title="class in org.apache.logging.log4j.core.async">AsyncLogger</a></td> |
| <td class="colLast"> |
| <div class="block">AsyncLogger is a logger designed for high throughput and low latency logging.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfig.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfig</a></td> |
| <td class="colLast"> |
| <div class="block">Asynchronous Logger object that is created via configuration and can be |
| combined with synchronous loggers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfig.RootLogger.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfig.RootLogger</a></td> |
| <td class="colLast"> |
| <div class="block">An asynchronous root Logger.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDefaultExceptionHandler.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfigDefaultExceptionHandler</a></td> |
| <td class="colLast"> |
| <div class="block">Default disruptor exception handler for errors that occur in the AsyncLogger background thread.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfigDisruptor</a></td> |
| <td class="colLast"> |
| <div class="block">Helper class decoupling the <code>AsyncLoggerConfig</code> class from the LMAX Disruptor library.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.Log4jEventWrapper.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfigDisruptor.Log4jEventWrapper</a></td> |
| <td class="colLast"> |
| <div class="block">RingBuffer events contain all information necessary to perform the work in a separate thread.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerContext.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerContext</a></td> |
| <td class="colLast"> |
| <div class="block"><code>LoggerContext</code> that creates <code>AsyncLogger</code> objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerContextSelector.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerContextSelector</a></td> |
| <td class="colLast"> |
| <div class="block"><code>ContextSelector</code> that manages <code>AsyncLoggerContext</code> instances.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerDefaultExceptionHandler.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerDefaultExceptionHandler</a></td> |
| <td class="colLast"> |
| <div class="block">Default disruptor exception handler for errors that occur in the AsyncLogger background thread.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncQueueFullMessageUtil.html" title="class in org.apache.logging.log4j.core.async">AsyncQueueFullMessageUtil</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Consider this class private.</b></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncQueueFullPolicyFactory.html" title="class in org.apache.logging.log4j.core.async">AsyncQueueFullPolicyFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Creates <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncQueueFullPolicy.html" title="interface in org.apache.logging.log4j.core.async"><code>AsyncQueueFullPolicy</code></a> instances based on user-specified system properties.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/DefaultAsyncQueueFullPolicy.html" title="class in org.apache.logging.log4j.core.async">DefaultAsyncQueueFullPolicy</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/DiscardingAsyncQueueFullPolicy.html" title="class in org.apache.logging.log4j.core.async">DiscardingAsyncQueueFullPolicy</a></td> |
| <td class="colLast"> |
| <div class="block">Discarding router extends the DefaultAsyncQueueFullPolicy by first verifying if the queue is fuller than the specified |
| threshold ratio; if this is the case, log events more specific than |
| the specified threshold level are dropped.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/DisruptorBlockingQueueFactory.html" title="class in org.apache.logging.log4j.core.async">DisruptorBlockingQueueFactory</a><E></td> |
| <td class="colLast"> |
| <div class="block">Factory for creating instances of <code>DisruptorBlockingQueue</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/InternalAsyncUtil.html" title="class in org.apache.logging.log4j.core.async">InternalAsyncUtil</a></td> |
| <td class="colLast"> |
| <div class="block">Helper class providing some async logging-related functionality.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/JCToolsBlockingQueueFactory.html" title="class in org.apache.logging.log4j.core.async">JCToolsBlockingQueueFactory</a><E></td> |
| <td class="colLast"> |
| <div class="block">Factory for creating instances of BlockingQueues backed by JCTools <code>MpscArrayQueue</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/LinkedTransferQueueFactory.html" title="class in org.apache.logging.log4j.core.async">LinkedTransferQueueFactory</a><E></td> |
| <td class="colLast"> |
| <div class="block">Factory for creating instances of <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/LinkedTransferQueue.html?is-external=true" title="class or interface in java.util.concurrent"><code>LinkedTransferQueue</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/RingBufferLogEvent.html" title="class in org.apache.logging.log4j.core.async">RingBufferLogEvent</a></td> |
| <td class="colLast"> |
| <div class="block">When the Disruptor is started, the RingBuffer is populated with event objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/RingBufferLogEventHandler.html" title="class in org.apache.logging.log4j.core.async">RingBufferLogEventHandler</a></td> |
| <td class="colLast"> |
| <div class="block">This event handler gets passed messages from the RingBuffer as they become |
| available.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/RingBufferLogEventTranslator.html" title="class in org.apache.logging.log4j.core.async">RingBufferLogEventTranslator</a></td> |
| <td class="colLast"> |
| <div class="block">This class is responsible for writing elements that make up a log event into |
| the ringbuffer <code>RingBufferLogEvent</code>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/EventRoute.html" title="enum in org.apache.logging.log4j.core.async">EventRoute</a></td> |
| <td class="colLast"> |
| <div class="block">Enumeration over the different destinations where a log event can be sent.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/JCToolsBlockingQueueFactory.WaitStrategy.html" title="enum in org.apache.logging.log4j.core.async">JCToolsBlockingQueueFactory.WaitStrategy</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/logging/log4j/core/async/ThreadNameCachingStrategy.html" title="enum in org.apache.logging.log4j.core.async">ThreadNameCachingStrategy</a></td> |
| <td class="colLast"> |
| <div class="block">Strategy for deciding whether thread name should be cached or not.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.logging.log4j.core.async Description">Package org.apache.logging.log4j.core.async Description</h2> |
| <div class="block">Provides Asynchronous Logger classes and interfaces for low-latency logging.</div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/appender/routing/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/config/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/async/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><p align="center">Copyright © 1999-2020 <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> |
| </body> |
| </html> |
