| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AsyncAppender (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="declaration: package: org.apache.logging.log4j.core.appender, class: AsyncAppender"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <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="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| 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="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/AsyncAppender.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.core.appender</a></div> |
| <h1 title="Class AsyncAppender" class="title">Class AsyncAppender</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">org.apache.logging.log4j.core.AbstractLifeCycle</a> |
| <div class="inheritance"><a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">org.apache.logging.log4j.core.filter.AbstractFilterable</a> |
| <div class="inheritance"><a href="AbstractAppender.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.AbstractAppender</a> |
| <div class="inheritance">org.apache.logging.log4j.core.appender.AsyncAppender</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a></code>, <code><a href="../filter/Filterable.html" title="interface in org.apache.logging.log4j.core.filter">Filterable</a></code>, <code><a href="../impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></code>, <code><a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></code>, <code><a href="../LifeCycle2.html" title="interface in org.apache.logging.log4j.core">LifeCycle2</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="../config/plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@Plugin</a>(<a href="../config/plugins/Plugin.html#name()">name</a>="Async", |
| <a href="../config/plugins/Plugin.html#category()">category</a>="Core", |
| <a href="../config/plugins/Plugin.html#elementType()">elementType</a>="appender", |
| <a href="../config/plugins/Plugin.html#printObject()">printObject</a>=true) |
| </span><span class="modifiers">public final class </span><span class="element-name type-name-label">AsyncAppender</span> |
| <span class="extends-implements">extends <a href="AbstractAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender</a></span></div> |
| <div class="block">Appends to one or more Appenders asynchronously. You can configure an AsyncAppender with one or more Appenders and an |
| Appender to append to if the queue is full. The AsyncAppender does not allow a filter to be specified on the Appender |
| references.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="AsyncAppender.Builder.html" class="type-name-link" title="class in org.apache.logging.log4j.core.appender">AsyncAppender.Builder</a><<a href="AsyncAppender.Builder.html" title="type parameter in AsyncAppender.Builder">B</a> extends <a href="AsyncAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender.Builder</a><<a href="AsyncAppender.Builder.html" title="type parameter in AsyncAppender.Builder">B</a>>></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.LifeCycle">Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.<a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h2> |
| <code><a href="../LifeCycle.State.html" title="enum in org.apache.logging.log4j.core">LifeCycle.State</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Fields inherited from class org.apache.logging.log4j.core.<a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3> |
| <code><a href="../AbstractLifeCycle.html#DEFAULT_STOP_TIMEOUT">DEFAULT_STOP_TIMEOUT</a>, <a href="../AbstractLifeCycle.html#DEFAULT_STOP_TIMEUNIT">DEFAULT_STOP_TIMEUNIT</a>, <a href="../AbstractLifeCycle.html#LOGGER">LOGGER</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.Appender">Fields inherited from interface org.apache.logging.log4j.core.<a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a></h3> |
| <code><a href="../Appender.html#ELEMENT_TYPE">ELEMENT_TYPE</a>, <a href="../Appender.html#EMPTY_ARRAY">EMPTY_ARRAY</a></code></div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#append(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">append</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> logEvent)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Actual writing occurs here.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="AsyncAppender.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#createAppender(org.apache.logging.log4j.core.config.AppenderRef%5B%5D,java.lang.String,boolean,long,int,java.lang.String,boolean,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.core.config.Configuration,boolean)" class="member-name-link">createAppender</a><wbr>(<a href="../config/AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a>[] appenderRefs, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> errorRef, |
| boolean blocking, |
| long shutdownTimeout, |
| int size, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| boolean includeLocation, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter, |
| <a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| boolean ignoreExceptions)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="AsyncAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender"><code>AsyncAppender.Builder</code></a> instead</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAppenderRefStrings()" class="member-name-link">getAppenderRefStrings</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the names of the appenders that this asyncAppender delegates to as an array of Strings.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAppenders()" class="member-name-link">getAppenders</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets all Appenders.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getErrorRef()" class="member-name-link">getErrorRef</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the name of the appender that any errors are logged to or <code>null</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQueueCapacity()" class="member-name-link">getQueueCapacity</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQueueRemainingCapacity()" class="member-name-link">getQueueRemainingCapacity</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQueueSize()" class="member-name-link">getQueueSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of elements in the queue.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isBlocking()" class="member-name-link">isBlocking</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns <code>true</code> if this AsyncAppender will block when the queue is full, or <code>false</code> if events are |
| dropped when the queue is full.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isIncludeLocation()" class="member-name-link">isIncludeLocation</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns <code>true</code> if this AsyncAppender will take a snapshot of the stack with every log event to determine |
| the class and method where the logging call was made.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#logMessageInBackgroundThread(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">logMessageInBackgroundThread</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> logEvent)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">FOR INTERNAL USE ONLY.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#logMessageInCurrentThread(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">logMessageInCurrentThread</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> logEvent)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">FOR INTERNAL USE ONLY.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="AsyncAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newBuilder()" class="member-name-link">newBuilder</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start()" class="member-name-link">start</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Make the Filter available for use.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stop(long,java.util.concurrent.TimeUnit)" class="member-name-link">stop</a><wbr>(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> timeUnit)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Cleanup the Filter.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractAppender">Methods inherited from class org.apache.logging.log4j.core.appender.<a href="AbstractAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender</a></h3> |
| <code><a href="AbstractAppender.html#error(java.lang.String)">error</a>, <a href="AbstractAppender.html#error(java.lang.String,java.lang.Throwable)">error</a>, <a href="AbstractAppender.html#error(java.lang.String,org.apache.logging.log4j.core.LogEvent,java.lang.Throwable)">error</a>, <a href="AbstractAppender.html#getHandler()">getHandler</a>, <a href="AbstractAppender.html#getLayout()">getLayout</a>, <a href="AbstractAppender.html#getName()">getName</a>, <a href="AbstractAppender.html#ignoreExceptions()">ignoreExceptions</a>, <a href="AbstractAppender.html#parseInt(java.lang.String,int)">parseInt</a>, <a href="AbstractAppender.html#requiresLocation()">requiresLocation</a>, <a href="AbstractAppender.html#setHandler(org.apache.logging.log4j.core.ErrorHandler)">setHandler</a>, <a href="AbstractAppender.html#toSerializable(org.apache.logging.log4j.core.LogEvent)">toSerializable</a>, <a href="AbstractAppender.html#toString()">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.filter.AbstractFilterable">Methods inherited from class org.apache.logging.log4j.core.filter.<a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></h3> |
| <code><a href="../filter/AbstractFilterable.html#addFilter(org.apache.logging.log4j.core.Filter)">addFilter</a>, <a href="../filter/AbstractFilterable.html#getFilter()">getFilter</a>, <a href="../filter/AbstractFilterable.html#getPropertyArray()">getPropertyArray</a>, <a href="../filter/AbstractFilterable.html#hasFilter()">hasFilter</a>, <a href="../filter/AbstractFilterable.html#isFiltered(org.apache.logging.log4j.core.LogEvent)">isFiltered</a>, <a href="../filter/AbstractFilterable.html#removeFilter(org.apache.logging.log4j.core.Filter)">removeFilter</a>, <a href="../filter/AbstractFilterable.html#stop(long,java.util.concurrent.TimeUnit,boolean)">stop</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Methods inherited from class org.apache.logging.log4j.core.<a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3> |
| <code><a href="../AbstractLifeCycle.html#equalsImpl(java.lang.Object)">equalsImpl</a>, <a href="../AbstractLifeCycle.html#getState()">getState</a>, <a href="../AbstractLifeCycle.html#getStatusLogger()">getStatusLogger</a>, <a href="../AbstractLifeCycle.html#hashCodeImpl()">hashCodeImpl</a>, <a href="../AbstractLifeCycle.html#initialize()">initialize</a>, <a href="../AbstractLifeCycle.html#isInitialized()">isInitialized</a>, <a href="../AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../AbstractLifeCycle.html#setStarted()">setStarted</a>, <a href="../AbstractLifeCycle.html#setStarting()">setStarting</a>, <a href="../AbstractLifeCycle.html#setState(org.apache.logging.log4j.core.LifeCycle.State)">setState</a>, <a href="../AbstractLifeCycle.html#setStopped()">setStopped</a>, <a href="../AbstractLifeCycle.html#setStopping()">setStopping</a>, <a href="../AbstractLifeCycle.html#stop()">stop</a>, <a href="../AbstractLifeCycle.html#stop(java.util.concurrent.Future)">stop</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.LifeCycle">Methods inherited from interface org.apache.logging.log4j.core.<a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h3> |
| <code><a href="../LifeCycle.html#getState()">getState</a>, <a href="../LifeCycle.html#initialize()">initialize</a>, <a href="../LifeCycle.html#isStarted()">isStarted</a>, <a href="../LifeCycle.html#isStopped()">isStopped</a>, <a href="../LifeCycle.html#stop()">stop</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="start()"> |
| <h3>start</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">start</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../filter/AbstractFilterable.html#start()">AbstractFilterable</a></code></span></div> |
| <div class="block">Make the Filter available for use.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../LifeCycle.html#start()">start</a></code> in interface <code><a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../filter/AbstractFilterable.html#start()">start</a></code> in class <code><a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stop(long,java.util.concurrent.TimeUnit)"> |
| <h3>stop</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">stop</span><wbr><span class="parameters">(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> timeUnit)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../filter/AbstractFilterable.html#stop(long,java.util.concurrent.TimeUnit)">AbstractFilterable</a></code></span></div> |
| <div class="block">Cleanup the Filter.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../LifeCycle2.html#stop(long,java.util.concurrent.TimeUnit)">stop</a></code> in interface <code><a href="../LifeCycle2.html" title="interface in org.apache.logging.log4j.core">LifeCycle2</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../filter/AbstractFilterable.html#stop(long,java.util.concurrent.TimeUnit)">stop</a></code> in class <code><a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>timeout</code> - the maximum time to wait</dd> |
| <dd><code>timeUnit</code> - the time unit of the timeout argument</dd> |
| <dt>Returns:</dt> |
| <dd>true if the receiver was stopped cleanly and normally, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="append(org.apache.logging.log4j.core.LogEvent)"> |
| <h3>append</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">append</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> logEvent)</span></div> |
| <div class="block">Actual writing occurs here.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>logEvent</code> - The LogEvent.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="logMessageInCurrentThread(org.apache.logging.log4j.core.LogEvent)"> |
| <h3>logMessageInCurrentThread</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">logMessageInCurrentThread</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> logEvent)</span></div> |
| <div class="block">FOR INTERNAL USE ONLY.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>logEvent</code> - the event to log</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="logMessageInBackgroundThread(org.apache.logging.log4j.core.LogEvent)"> |
| <h3>logMessageInBackgroundThread</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">logMessageInBackgroundThread</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> logEvent)</span></div> |
| <div class="block">FOR INTERNAL USE ONLY.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>logEvent</code> - the event to log</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createAppender(org.apache.logging.log4j.core.config.AppenderRef[],java.lang.String,boolean,long,int,java.lang.String,boolean,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.core.config.Configuration,boolean)"> |
| <h3>createAppender</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="AsyncAppender.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender</a></span> <span class="element-name">createAppender</span><wbr><span class="parameters">(<a href="../config/AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a>[] appenderRefs, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> errorRef, |
| boolean blocking, |
| long shutdownTimeout, |
| int size, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| boolean includeLocation, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter, |
| <a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| boolean ignoreExceptions)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="AsyncAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender"><code>AsyncAppender.Builder</code></a> instead</div> |
| </div> |
| <div class="block">Create an AsyncAppender. This method is retained for backwards compatibility. New code should use the |
| <a href="AsyncAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender"><code>AsyncAppender.Builder</code></a> instead. This factory will use <a href="../async/ArrayBlockingQueueFactory.html" title="class in org.apache.logging.log4j.core.async"><code>ArrayBlockingQueueFactory</code></a> by default as was the behavior |
| pre-2.7.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>appenderRefs</code> - The Appenders to reference.</dd> |
| <dd><code>errorRef</code> - An optional Appender to write to if the queue is full or other errors occur.</dd> |
| <dd><code>blocking</code> - True if the Appender should wait when the queue is full. The default is true.</dd> |
| <dd><code>shutdownTimeout</code> - How many milliseconds the Appender should wait to flush outstanding log events |
| in the queue on shutdown. The default is zero which means to wait forever.</dd> |
| <dd><code>size</code> - The size of the event queue. The default is 128.</dd> |
| <dd><code>name</code> - The name of the Appender.</dd> |
| <dd><code>includeLocation</code> - whether to include location information. The default is false.</dd> |
| <dd><code>filter</code> - The Filter or null.</dd> |
| <dd><code>config</code> - The Configuration.</dd> |
| <dd><code>ignoreExceptions</code> - If <code>"true"</code> (default) exceptions encountered when appending events are logged; |
| otherwise they are propagated to the caller.</dd> |
| <dt>Returns:</dt> |
| <dd>The AsyncAppender.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newBuilder()"> |
| <h3>newBuilder</h3> |
| <div class="member-signature"><span class="annotations"><a href="../config/plugins/PluginBuilderFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginBuilderFactory</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="AsyncAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender.Builder</a></span> <span class="element-name">newBuilder</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAppenderRefStrings()"> |
| <h3>getAppenderRefStrings</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span> <span class="element-name">getAppenderRefStrings</span>()</div> |
| <div class="block">Returns the names of the appenders that this asyncAppender delegates to as an array of Strings.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the names of the sink appenders</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isIncludeLocation()"> |
| <h3>isIncludeLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isIncludeLocation</span>()</div> |
| <div class="block">Returns <code>true</code> if this AsyncAppender will take a snapshot of the stack with every log event to determine |
| the class and method where the logging call was made.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if location is included with every event, <code>false</code> otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isBlocking()"> |
| <h3>isBlocking</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isBlocking</span>()</div> |
| <div class="block">Returns <code>true</code> if this AsyncAppender will block when the queue is full, or <code>false</code> if events are |
| dropped when the queue is full.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether this AsyncAppender will block or drop events when the queue is full.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAppenders()"> |
| <h3>getAppenders</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a>></span> <span class="element-name">getAppenders</span>()</div> |
| <div class="block">Gets all Appenders.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a list of Appenders.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getErrorRef()"> |
| <h3>getErrorRef</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getErrorRef</span>()</div> |
| <div class="block">Returns the name of the appender that any errors are logged to or <code>null</code>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the name of the appender that any errors are logged to or <code>null</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQueueCapacity()"> |
| <h3>getQueueCapacity</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getQueueCapacity</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQueueRemainingCapacity()"> |
| <h3>getQueueRemainingCapacity</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getQueueRemainingCapacity</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQueueSize()"> |
| <h3>getQueueSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getQueueSize</span>()</div> |
| <div class="block">Returns the number of elements in the queue.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the number of elements in the queue.</dd> |
| <dt>Since:</dt> |
| <dd>2.11.1</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 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> |
