| <!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 Sat Apr 25 12:11:41 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AsyncLoggerConfigDelegate (Apache Log4j Core 2.13.2 API)</title> |
| <meta name="date" content="2020-04-25"> |
| <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="AsyncLoggerConfigDelegate (Apache Log4j Core 2.13.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AsyncLoggerConfigDelegate.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/AsyncLoggerConfigDefaultExceptionHandler.html" title="class 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.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/AsyncLoggerConfigDelegate.html" target="_top">Frames</a></li> |
| <li><a href="AsyncLoggerConfigDelegate.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface AsyncLoggerConfigDelegate" class="title">Interface AsyncLoggerConfigDelegate</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/logging/log4j/core/async/AsyncLoggerConfigDisruptor.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfigDisruptor</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#line.29">AsyncLoggerConfigDelegate</a></pre> |
| <div class="block">Encapsulates the mechanism used to log asynchronously. There is one delegate per configuration, which is shared by |
| all AsyncLoggerConfig objects in the configuration.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/AsyncLoggerConfigDelegate.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/AsyncLoggerConfigDelegate.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/AsyncLoggerConfigDelegate.html#getEventRoute-org.apache.logging.log4j.Level-">getEventRoute</a></span>(org.apache.logging.log4j.Level level)</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/AsyncLoggerConfigDelegate.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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createRingBufferAdmin-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createRingBufferAdmin</h4> |
| <pre><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/AsyncLoggerConfigDelegate.html#line.39">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">Creates and returns a new <code>RingBufferAdmin</code> that instruments the ringbuffer of this |
| <code>AsyncLoggerConfig</code>.</div> |
| <dl> |
| <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> |
| <a name="getEventRoute-org.apache.logging.log4j.Level-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEventRoute</h4> |
| <pre><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/AsyncLoggerConfigDelegate.html#line.47">getEventRoute</a>(org.apache.logging.log4j.Level level)</pre> |
| <div class="block">Returns the <code>EventRoute</code> for the event with the specified level.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>level</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>void <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#line.54">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">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>tryEnqueue(LogEvent, AsyncLoggerConfig)</code></a> returns <code>false</code> |
| indicating that the ringbuffer is full, otherwise it may incur unnecessary synchronization.</div> |
| </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>boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#line.56">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> |
| </li> |
| </ul> |
| <a name="setLogEventFactory-org.apache.logging.log4j.core.impl.LogEventFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setLogEventFactory</h4> |
| <pre>void <a href="../../../../../../src-html/org/apache/logging/log4j/core/async/AsyncLoggerConfigDelegate.html#line.65">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">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="paramLabel">Parameters:</span></dt> |
| <dd><code>logEventFactory</code> - the factory used</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/AsyncLoggerConfigDelegate.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/AsyncLoggerConfigDefaultExceptionHandler.html" title="class 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.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/AsyncLoggerConfigDelegate.html" target="_top">Frames</a></li> |
| <li><a href="AsyncLoggerConfigDelegate.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
