| <!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:46 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AsyncLoggerConfigDisruptor (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="AsyncLoggerConfigDisruptor (Apache Log4j Core 2.13.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AsyncLoggerConfigDisruptor.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/async/AsyncLoggerConfigDelegate.html" title="interface in org.apache.logging.log4j.core.async"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.Log4jEventWrapper.html" title="class in org.apache.logging.log4j.core.async"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html" target="_top">Frames</a></li> |
| <li><a href="AsyncLoggerConfigDisruptor.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.logging.log4j.core.AbstractLifeCycle">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.logging.log4j.core.async</div> |
| <h2 title="Class AsyncLoggerConfigDisruptor" class="title">Class AsyncLoggerConfigDisruptor</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">org.apache.logging.log4j.core.AbstractLifeCycle</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.logging.log4j.core.async.AsyncLoggerConfigDisruptor</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html" title="interface in org.apache.logging.log4j.core.async">AsyncLoggerConfigDelegate</a>, <a href="../../../../../../org/apache/logging/log4j/core/LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a>, <a href="../../../../../../org/apache/logging/log4j/core/LifeCycle2.html" title="interface in org.apache.logging.log4j.core">LifeCycle2</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#line.57">AsyncLoggerConfigDisruptor</a> |
| extends <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a> |
| implements <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html" title="interface in org.apache.logging.log4j.core.async">AsyncLoggerConfigDelegate</a></pre> |
| <div class="block">Helper class decoupling the <code>AsyncLoggerConfig</code> class from the LMAX Disruptor library. |
| <p> |
| <code>AsyncLoggerConfig</code> is a plugin, and will be loaded even if users do not configure any <code><asyncLogger></code> or |
| <code><asyncRoot></code> elements in the configuration. If <code>AsyncLoggerConfig</code> has inner classes that extend or |
| implement classes from the Disruptor library, a <code>NoClassDefFoundError</code> is thrown if the Disruptor jar is not in |
| the classpath when the PluginManager loads the <code>AsyncLoggerConfig</code> plugin from the pre-defined plugins |
| definition file. |
| <p> |
| This class serves to make the dependency on the Disruptor optional, so that these classes are only loaded when the |
| <code>AsyncLoggerConfig</code> is actually used.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.Log4jEventWrapper.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfigDisruptor.Log4jEventWrapper</a></span></code> |
| <div class="block">RingBuffer events contain all information necessary to perform the work in a separate thread.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.logging.log4j.core.LifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.<a href="../../../../../../org/apache/logging/log4j/core/LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/LifeCycle.State.html" title="enum in org.apache.logging.log4j.core">LifeCycle.State</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.logging.log4j.core.<a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#DEFAULT_STOP_TIMEOUT">DEFAULT_STOP_TIMEOUT</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#DEFAULT_STOP_TIMEUNIT">DEFAULT_STOP_TIMEUNIT</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#LOGGER">LOGGER</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#AsyncLoggerConfigDisruptor--">AsyncLoggerConfigDisruptor</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/jmx/RingBufferAdmin.html" title="class in org.apache.logging.log4j.core.jmx">RingBufferAdmin</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#createRingBufferAdmin-java.lang.String-java.lang.String-">createRingBufferAdmin</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contextName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> loggerConfigName)</code> |
| <div class="block">Creates and returns a new <code>RingBufferAdmin</code> that instruments the ringbuffer of this |
| <code>AsyncLoggerConfig</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#enqueueEvent-org.apache.logging.log4j.core.LogEvent-org.apache.logging.log4j.core.async.AsyncLoggerConfig-">enqueueEvent</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfig.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfig</a> asyncLoggerConfig)</code> |
| <div class="block">Enqueues the <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a> on the mixed configuration ringbuffer.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/async/EventRoute.html" title="enum in org.apache.logging.log4j.core.async">EventRoute</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#getEventRoute-org.apache.logging.log4j.Level-">getEventRoute</a></span>(org.apache.logging.log4j.Level logLevel)</code> |
| <div class="block">Returns the <code>EventRoute</code> for the event with the specified level.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#setLogEventFactory-org.apache.logging.log4j.core.impl.LogEventFactory-">setLogEventFactory</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/impl/LogEventFactory.html" title="interface in org.apache.logging.log4j.core.impl">LogEventFactory</a> logEventFactory)</code> |
| <div class="block">Notifies the delegate what LogEventFactory an AsyncLoggerConfig is using, so the delegate can determine |
| whether to populate the ring buffer with mutable log events or not.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#start--">start</a></span>()</code> |
| <div class="block">Increases the reference count and creates and starts a new Disruptor and associated thread if none currently |
| exists.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#stop-long-java.util.concurrent.TimeUnit-">stop</a></span>(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</code> |
| <div class="block">Decreases the reference count.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#tryEnqueue-org.apache.logging.log4j.core.LogEvent-org.apache.logging.log4j.core.async.AsyncLoggerConfig-">tryEnqueue</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfig.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfig</a> asyncLoggerConfig)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.logging.log4j.core.<a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#equalsImpl-java.lang.Object-">equalsImpl</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#getState--">getState</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#getStatusLogger--">getStatusLogger</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#hashCodeImpl--">hashCodeImpl</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#initialize--">initialize</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#isInitialized--">isInitialized</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#isStarted--">isStarted</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#isStarting--">isStarting</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#isStopped--">isStopped</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#isStopping--">isStopping</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#setStarted--">setStarted</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#setStarting--">setStarting</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#setState-org.apache.logging.log4j.core.LifeCycle.State-">setState</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#setStopped--">setStopped</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#setStopping--">setStopping</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#stop--">stop</a>, <a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#stop-java.util.concurrent.Future-">stop</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AsyncLoggerConfigDisruptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AsyncLoggerConfigDisruptor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#line.191">AsyncLoggerConfigDisruptor</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setLogEventFactory-org.apache.logging.log4j.core.impl.LogEventFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLogEventFactory</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#line.196">setLogEventFactory</a>(<a href="../../../../../../org/apache/logging/log4j/core/impl/LogEventFactory.html" title="interface in org.apache.logging.log4j.core.impl">LogEventFactory</a> logEventFactory)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#setLogEventFactory-org.apache.logging.log4j.core.impl.LogEventFactory-">AsyncLoggerConfigDelegate</a></code></span></div> |
| <div class="block">Notifies the delegate what LogEventFactory an AsyncLoggerConfig is using, so the delegate can determine |
| whether to populate the ring buffer with mutable log events or not. This method may be invoked multiple times |
| for all AsyncLoggerConfigs that use this delegate.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#setLogEventFactory-org.apache.logging.log4j.core.impl.LogEventFactory-">setLogEventFactory</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html" title="interface in org.apache.logging.log4j.core.async">AsyncLoggerConfigDelegate</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>logEventFactory</code> - the factory used</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#line.209">start</a>()</pre> |
| <div class="block">Increases the reference count and creates and starts a new Disruptor and associated thread if none currently |
| exists.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/LifeCycle.html#start--">start</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#start--">start</a></code> in class <code><a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#stop--"><code>AbstractLifeCycle.stop()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stop-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#line.251">stop</a>(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</pre> |
| <div class="block">Decreases the reference count. If the reference count reached zero, the Disruptor and its associated thread are |
| shut down and their references set to <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/LifeCycle2.html#stop-long-java.util.concurrent.TimeUnit-">stop</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/LifeCycle2.html" title="interface in org.apache.logging.log4j.core">LifeCycle2</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html#stop-long-java.util.concurrent.TimeUnit-">stop</a></code> in class <code><a href="../../../../../../org/apache/logging/log4j/core/AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - the maximum time to wait</dd> |
| <dd><code>timeUnit</code> - the time unit of the timeout argument</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the receiver was stopped cleanly and normally, false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEventRoute-org.apache.logging.log4j.Level-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEventRoute</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/async/EventRoute.html" title="enum in org.apache.logging.log4j.core.async">EventRoute</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#line.298">getEventRoute</a>(org.apache.logging.log4j.Level logLevel)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#getEventRoute-org.apache.logging.log4j.Level-">AsyncLoggerConfigDelegate</a></code></span></div> |
| <div class="block">Returns the <code>EventRoute</code> for the event with the specified level.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#getEventRoute-org.apache.logging.log4j.Level-">getEventRoute</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html" title="interface in org.apache.logging.log4j.core.async">AsyncLoggerConfigDelegate</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>logLevel</code> - the level of the event to log</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>EventRoute</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="enqueueEvent-org.apache.logging.log4j.core.LogEvent-org.apache.logging.log4j.core.async.AsyncLoggerConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enqueueEvent</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#line.326">enqueueEvent</a>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfig.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfig</a> asyncLoggerConfig)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#enqueueEvent-org.apache.logging.log4j.core.LogEvent-org.apache.logging.log4j.core.async.AsyncLoggerConfig-">AsyncLoggerConfigDelegate</a></code></span></div> |
| <div class="block">Enqueues the <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a> on the mixed configuration ringbuffer. |
| This method must only be used after <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#tryEnqueue-org.apache.logging.log4j.core.LogEvent-org.apache.logging.log4j.core.async.AsyncLoggerConfig-"><code>AsyncLoggerConfigDelegate.tryEnqueue(LogEvent, AsyncLoggerConfig)</code></a> returns <code>false</code> |
| indicating that the ringbuffer is full, otherwise it may incur unnecessary synchronization.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#enqueueEvent-org.apache.logging.log4j.core.LogEvent-org.apache.logging.log4j.core.async.AsyncLoggerConfig-">enqueueEvent</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html" title="interface in org.apache.logging.log4j.core.async">AsyncLoggerConfigDelegate</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tryEnqueue-org.apache.logging.log4j.core.LogEvent-org.apache.logging.log4j.core.async.AsyncLoggerConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tryEnqueue</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#line.390">tryEnqueue</a>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfig.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfig</a> asyncLoggerConfig)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#tryEnqueue-org.apache.logging.log4j.core.LogEvent-org.apache.logging.log4j.core.async.AsyncLoggerConfig-">tryEnqueue</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html" title="interface in org.apache.logging.log4j.core.async">AsyncLoggerConfigDelegate</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createRingBufferAdmin-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createRingBufferAdmin</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/jmx/RingBufferAdmin.html" title="class in org.apache.logging.log4j.core.jmx">RingBufferAdmin</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html#line.416">createRingBufferAdmin</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contextName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> loggerConfigName)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#createRingBufferAdmin-java.lang.String-java.lang.String-">AsyncLoggerConfigDelegate</a></code></span></div> |
| <div class="block">Creates and returns a new <code>RingBufferAdmin</code> that instruments the ringbuffer of this |
| <code>AsyncLoggerConfig</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#createRingBufferAdmin-java.lang.String-java.lang.String-">createRingBufferAdmin</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html" title="interface in org.apache.logging.log4j.core.async">AsyncLoggerConfigDelegate</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>contextName</code> - name of the <code>LoggerContext</code></dd> |
| <dd><code>loggerConfigName</code> - name of the logger config</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the RingBufferAdmin that instruments the ringbuffer</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= 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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AsyncLoggerConfigDisruptor.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/async/AsyncLoggerConfigDelegate.html" title="interface in org.apache.logging.log4j.core.async"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.Log4jEventWrapper.html" title="class in org.apache.logging.log4j.core.async"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html" target="_top">Frames</a></li> |
| <li><a href="AsyncLoggerConfigDisruptor.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.logging.log4j.core.AbstractLifeCycle">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |
