| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TcpSocketManager (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.net, class: TcpSocketManager"> |
| <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/TcpSocketManager.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><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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.net</a></div> |
| <h1 title="Class TcpSocketManager" class="title">Class TcpSocketManager</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="../appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.AbstractManager</a> |
| <div class="inheritance"><a href="../appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.OutputStreamManager</a> |
| <div class="inheritance"><a href="AbstractSocketManager.html" title="class in org.apache.logging.log4j.core.net">org.apache.logging.log4j.core.net.AbstractSocketManager</a> |
| <div class="inheritance">org.apache.logging.log4j.core.net.TcpSocketManager</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="../layout/ByteBufferDestination.html" title="interface in org.apache.logging.log4j.core.layout">ByteBufferDestination</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="SslSocketManager.html" title="class in org.apache.logging.log4j.core.net">SslSocketManager</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TcpSocketManager</span> |
| <span class="extends-implements">extends <a href="AbstractSocketManager.html" title="class in org.apache.logging.log4j.core.net">AbstractSocketManager</a></span></div> |
| <div class="block">Manager of TCP Socket connections.</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="TcpSocketManager.HostResolver.html" class="type-name-link" title="class in org.apache.logging.log4j.core.net">TcpSocketManager.HostResolver</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="TcpSocketManager.TcpSocketManagerFactory.html" class="type-name-link" title="class in org.apache.logging.log4j.core.net">TcpSocketManager.TcpSocketManagerFactory</a><<a href="TcpSocketManager.TcpSocketManagerFactory.html" title="type parameter in TcpSocketManager.TcpSocketManagerFactory">M</a> extends <a href="TcpSocketManager.html" title="class in org.apache.logging.log4j.core.net">TcpSocketManager</a>,<wbr><a href="TcpSocketManager.TcpSocketManagerFactory.html" title="type parameter in TcpSocketManager.TcpSocketManagerFactory">T</a> extends org.apache.logging.log4j.core.net.TcpSocketManager.FactoryData></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Factory to create a TcpSocketManager.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractManager">Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.<a href="../appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h2> |
| <code><a href="../appender/AbstractManager.AbstractFactoryData.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager.AbstractFactoryData</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</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">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_RECONNECTION_DELAY_MILLIS" class="member-name-link">DEFAULT_RECONNECTION_DELAY_MILLIS</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The default reconnection delay (30000 milliseconds or 30 seconds).</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.net.AbstractSocketManager">Fields inherited from class org.apache.logging.log4j.core.net.<a href="AbstractSocketManager.html" title="class in org.apache.logging.log4j.core.net">AbstractSocketManager</a></h3> |
| <code><a href="AbstractSocketManager.html#host">host</a>, <a href="AbstractSocketManager.html#inetAddress">inetAddress</a>, <a href="AbstractSocketManager.html#port">port</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.appender.OutputStreamManager">Fields inherited from class org.apache.logging.log4j.core.appender.<a href="../appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></h3> |
| <code><a href="../appender/OutputStreamManager.html#byteBuffer">byteBuffer</a>, <a href="../appender/OutputStreamManager.html#layout">layout</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractManager">Fields inherited from class org.apache.logging.log4j.core.appender.<a href="../appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h3> |
| <code><a href="../appender/AbstractManager.html#count">count</a>, <a href="../appender/AbstractManager.html#LOGGER">LOGGER</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.io.OutputStream,java.net.Socket,java.net.InetAddress,java.lang.String,int,int,int,boolean,org.apache.logging.log4j.core.Layout,int)" class="member-name-link">TcpSocketManager</a><wbr>(<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, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> os, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html" title="class or interface in java.net" class="external-link">Socket</a> socket, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a> inetAddress, |
| <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> host, |
| int port, |
| int connectTimeoutMillis, |
| int reconnectionDelayMillis, |
| boolean immediateFail, |
| <a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| int bufferSize)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use |
| <a href="#%3Cinit%3E(java.lang.String,java.io.OutputStream,java.net.Socket,java.net.InetAddress,java.lang.String,int,int,int,boolean,org.apache.logging.log4j.core.Layout,int,org.apache.logging.log4j.core.net.SocketOptions)"><code>TcpSocketManager(String, OutputStream, Socket, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.io.OutputStream,java.net.Socket,java.net.InetAddress,java.lang.String,int,int,int,boolean,org.apache.logging.log4j.core.Layout,int,org.apache.logging.log4j.core.net.SocketOptions)" class="member-name-link">TcpSocketManager</a><wbr>(<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, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> os, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html" title="class or interface in java.net" class="external-link">Socket</a> socket, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a> inetAddress, |
| <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> host, |
| int port, |
| int connectTimeoutMillis, |
| int reconnectionDelayMillis, |
| boolean immediateFail, |
| <a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| int bufferSize, |
| <a href="SocketOptions.html" title="class in org.apache.logging.log4j.core.net">SocketOptions</a> socketOptions)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Constructs.</div> |
| </div> |
| </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>protected boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#closeOutputStream()" class="member-name-link">closeOutputStream</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>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html" title="class or interface in java.net" class="external-link">Socket</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSocket(java.net.InetSocketAddress)" class="member-name-link">createSocket</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a> socketAddress)</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-tab1 method-summary-table-tab4"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html" title="class or interface in java.net" class="external-link">Socket</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createSocket(java.net.InetSocketAddress,org.apache.logging.log4j.core.net.SocketOptions,int)" class="member-name-link">createSocket</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a> socketAddress, |
| <a href="SocketOptions.html" title="class in org.apache.logging.log4j.core.net">SocketOptions</a> socketOptions, |
| int connectTimeoutMillis)</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>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConnectTimeoutMillis()" class="member-name-link">getConnectTimeoutMillis</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><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><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="#getContentFormat()" class="member-name-link">getContentFormat</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets this TcpSocketManager's content format.</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="#getReconnectionDelayMillis()" class="member-name-link">getReconnectionDelayMillis</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><a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html" title="class or interface in java.net" class="external-link">Socket</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSocket()" class="member-name-link">getSocket</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">USE AT YOUR OWN RISK, method is public for testing purpose only for now.</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="TcpSocketManager.html" title="class in org.apache.logging.log4j.core.net">TcpSocketManager</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="#getSocketManager(java.lang.String,int,int,int,boolean,org.apache.logging.log4j.core.Layout,int)" class="member-name-link">getSocketManager</a><wbr>(<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> host, |
| int port, |
| int connectTimeoutMillis, |
| int reconnectDelayMillis, |
| boolean immediateFail, |
| <a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| int bufferSize)</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="#getSocketManager(java.lang.String,int,int,int,boolean,org.apache.logging.log4j.core.Layout,int,org.apache.logging.log4j.core.net.SocketOptions)"><code>getSocketManager(String, int, int, int, boolean, Layout, int, SocketOptions)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TcpSocketManager.html" title="class in org.apache.logging.log4j.core.net">TcpSocketManager</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSocketManager(java.lang.String,int,int,int,boolean,org.apache.logging.log4j.core.Layout,int,org.apache.logging.log4j.core.net.SocketOptions)" class="member-name-link">getSocketManager</a><wbr>(<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> host, |
| int port, |
| int connectTimeoutMillis, |
| int reconnectDelayMillis, |
| boolean immediateFail, |
| <a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| int bufferSize, |
| <a href="SocketOptions.html" title="class in org.apache.logging.log4j.core.net">SocketOptions</a> socketOptions)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Obtains a TcpSocketManager.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SocketOptions.html" title="class in org.apache.logging.log4j.core.net">SocketOptions</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSocketOptions()" class="member-name-link">getSocketOptions</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">USE AT YOUR OWN RISK, method is public for testing purpose only for now.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setHostResolver(org.apache.logging.log4j.core.net.TcpSocketManager.HostResolver)" class="member-name-link">setHostResolver</a><wbr>(<a href="TcpSocketManager.HostResolver.html" title="class in org.apache.logging.log4j.core.net">TcpSocketManager.HostResolver</a> resolver)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">This method is only for unit testing.</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</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>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#write(byte%5B%5D,int,int,boolean)" class="member-name-link">write</a><wbr>(byte[] bytes, |
| int offset, |
| int length, |
| boolean immediateFlush)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Some output streams synchronize writes while others do not.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.net.AbstractSocketManager">Methods inherited from class org.apache.logging.log4j.core.net.<a href="AbstractSocketManager.html" title="class in org.apache.logging.log4j.core.net">AbstractSocketManager</a></h3> |
| <code><a href="AbstractSocketManager.html#getHost()">getHost</a>, <a href="AbstractSocketManager.html#getPort()">getPort</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.OutputStreamManager">Methods inherited from class org.apache.logging.log4j.core.appender.<a href="../appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></h3> |
| <code><a href="../appender/OutputStreamManager.html#createOutputStream()">createOutputStream</a>, <a href="../appender/OutputStreamManager.html#drain(java.nio.ByteBuffer)">drain</a>, <a href="../appender/OutputStreamManager.html#flush()">flush</a>, <a href="../appender/OutputStreamManager.html#flushBuffer(java.nio.ByteBuffer)">flushBuffer</a>, <a href="../appender/OutputStreamManager.html#flushDestination()">flushDestination</a>, <a href="../appender/OutputStreamManager.html#getByteBuffer()">getByteBuffer</a>, <a href="../appender/OutputStreamManager.html#getManager(java.lang.String,T,org.apache.logging.log4j.core.appender.ManagerFactory)">getManager</a>, <a href="../appender/OutputStreamManager.html#getOutputStream()">getOutputStream</a>, <a href="../appender/OutputStreamManager.html#hasOutputStream()">hasOutputStream</a>, <a href="../appender/OutputStreamManager.html#isOpen()">isOpen</a>, <a href="../appender/OutputStreamManager.html#releaseSub(long,java.util.concurrent.TimeUnit)">releaseSub</a>, <a href="../appender/OutputStreamManager.html#setOutputStream(java.io.OutputStream)">setOutputStream</a>, <a href="../appender/OutputStreamManager.html#skipFooter(boolean)">skipFooter</a>, <a href="../appender/OutputStreamManager.html#write(byte%5B%5D)">write</a>, <a href="../appender/OutputStreamManager.html#write(byte%5B%5D,boolean)">write</a>, <a href="../appender/OutputStreamManager.html#write(byte%5B%5D,int,int)">write</a>, <a href="../appender/OutputStreamManager.html#writeBytes(byte%5B%5D,int,int)">writeBytes</a>, <a href="../appender/OutputStreamManager.html#writeBytes(java.nio.ByteBuffer)">writeBytes</a>, <a href="../appender/OutputStreamManager.html#writeFooter()">writeFooter</a>, <a href="../appender/OutputStreamManager.html#writeHeader(java.io.OutputStream)">writeHeader</a>, <a href="../appender/OutputStreamManager.html#writeToDestination(byte%5B%5D,int,int)">writeToDestination</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractManager">Methods inherited from class org.apache.logging.log4j.core.appender.<a href="../appender/AbstractManager.html" title="class in org.apache.logging.log4j.core.appender">AbstractManager</a></h3> |
| <code><a href="../appender/AbstractManager.html#close()">close</a>, <a href="../appender/AbstractManager.html#getCount()">getCount</a>, <a href="../appender/AbstractManager.html#getLoggerContext()">getLoggerContext</a>, <a href="../appender/AbstractManager.html#getManager(java.lang.String,org.apache.logging.log4j.core.appender.ManagerFactory,T)">getManager</a>, <a href="../appender/AbstractManager.html#getName()">getName</a>, <a href="../appender/AbstractManager.html#getStrSubstitutor()">getStrSubstitutor</a>, <a href="../appender/AbstractManager.html#hasManager(java.lang.String)">hasManager</a>, <a href="../appender/AbstractManager.html#log(org.apache.logging.log4j.Level,java.lang.String,java.lang.Throwable)">log</a>, <a href="../appender/AbstractManager.html#logDebug(java.lang.String,java.lang.Throwable)">logDebug</a>, <a href="../appender/AbstractManager.html#logError(java.lang.String,java.lang.Throwable)">logError</a>, <a href="../appender/AbstractManager.html#logger()">logger</a>, <a href="../appender/AbstractManager.html#logWarn(java.lang.String,java.lang.Throwable)">logWarn</a>, <a href="../appender/AbstractManager.html#narrow(java.lang.Class,org.apache.logging.log4j.core.appender.AbstractManager)">narrow</a>, <a href="../appender/AbstractManager.html#release()">release</a>, <a href="../appender/AbstractManager.html#stop(long,java.util.concurrent.TimeUnit)">stop</a>, <a href="../appender/AbstractManager.html#updateData(java.lang.Object)">updateData</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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="DEFAULT_RECONNECTION_DELAY_MILLIS"> |
| <h3>DEFAULT_RECONNECTION_DELAY_MILLIS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_RECONNECTION_DELAY_MILLIS</span></div> |
| <div class="block">The default reconnection delay (30000 milliseconds or 30 seconds).</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.net.TcpSocketManager.DEFAULT_RECONNECTION_DELAY_MILLIS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.io.OutputStream,java.net.Socket,java.net.InetAddress,java.lang.String,int,int,int,boolean,org.apache.logging.log4j.core.Layout,int)"> |
| <h3>TcpSocketManager</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</span> <span class="element-name">TcpSocketManager</span><wbr><span class="parameters">(<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, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> os, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html" title="class or interface in java.net" class="external-link">Socket</a> socket, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a> inetAddress, |
| <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> host, |
| int port, |
| int connectTimeoutMillis, |
| int reconnectionDelayMillis, |
| boolean immediateFail, |
| <a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| int bufferSize)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use |
| <a href="#%3Cinit%3E(java.lang.String,java.io.OutputStream,java.net.Socket,java.net.InetAddress,java.lang.String,int,int,int,boolean,org.apache.logging.log4j.core.Layout,int,org.apache.logging.log4j.core.net.SocketOptions)"><code>TcpSocketManager(String, OutputStream, Socket, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions)</code></a>.</div> |
| </div> |
| <div class="block">Constructs.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The unique name of this connection.</dd> |
| <dd><code>os</code> - The OutputStream.</dd> |
| <dd><code>socket</code> - The Socket.</dd> |
| <dd><code>inetAddress</code> - The Internet address of the host.</dd> |
| <dd><code>host</code> - The name of the host.</dd> |
| <dd><code>port</code> - The port number on the host.</dd> |
| <dd><code>connectTimeoutMillis</code> - the connect timeout in milliseconds.</dd> |
| <dd><code>reconnectionDelayMillis</code> - Reconnection interval.</dd> |
| <dd><code>immediateFail</code> - True if the write should fail if no socket is immediately available.</dd> |
| <dd><code>layout</code> - The Layout.</dd> |
| <dd><code>bufferSize</code> - The buffer size.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.io.OutputStream,java.net.Socket,java.net.InetAddress,java.lang.String,int,int,int,boolean,org.apache.logging.log4j.core.Layout,int,org.apache.logging.log4j.core.net.SocketOptions)"> |
| <h3>TcpSocketManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TcpSocketManager</span><wbr><span class="parameters">(<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, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> os, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html" title="class or interface in java.net" class="external-link">Socket</a> socket, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a> inetAddress, |
| <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> host, |
| int port, |
| int connectTimeoutMillis, |
| int reconnectionDelayMillis, |
| boolean immediateFail, |
| <a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| int bufferSize, |
| <a href="SocketOptions.html" title="class in org.apache.logging.log4j.core.net">SocketOptions</a> socketOptions)</span></div> |
| <div class="block">Constructs.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The unique name of this connection.</dd> |
| <dd><code>os</code> - The OutputStream.</dd> |
| <dd><code>socket</code> - The Socket.</dd> |
| <dd><code>inetAddress</code> - The Internet address of the host.</dd> |
| <dd><code>host</code> - The name of the host.</dd> |
| <dd><code>port</code> - The port number on the host.</dd> |
| <dd><code>connectTimeoutMillis</code> - the connect timeout in milliseconds.</dd> |
| <dd><code>reconnectionDelayMillis</code> - Reconnection interval.</dd> |
| <dd><code>immediateFail</code> - True if the write should fail if no socket is immediately available.</dd> |
| <dd><code>layout</code> - The Layout.</dd> |
| <dd><code>bufferSize</code> - The buffer size.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getSocketManager(java.lang.String,int,int,int,boolean,org.apache.logging.log4j.core.Layout,int)"> |
| <h3>getSocketManager</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="TcpSocketManager.html" title="class in org.apache.logging.log4j.core.net">TcpSocketManager</a></span> <span class="element-name">getSocketManager</span><wbr><span class="parameters">(<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> host, |
| int port, |
| int connectTimeoutMillis, |
| int reconnectDelayMillis, |
| boolean immediateFail, |
| <a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| int bufferSize)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#getSocketManager(java.lang.String,int,int,int,boolean,org.apache.logging.log4j.core.Layout,int,org.apache.logging.log4j.core.net.SocketOptions)"><code>getSocketManager(String, int, int, int, boolean, Layout, int, SocketOptions)</code></a>.</div> |
| </div> |
| <div class="block">Obtains a TcpSocketManager.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>host</code> - The host to connect to.</dd> |
| <dd><code>port</code> - The port on the host.</dd> |
| <dd><code>connectTimeoutMillis</code> - the connect timeout in milliseconds</dd> |
| <dd><code>reconnectDelayMillis</code> - The interval to pause between retries.</dd> |
| <dd><code>bufferSize</code> - The buffer size.</dd> |
| <dt>Returns:</dt> |
| <dd>A TcpSocketManager.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSocketManager(java.lang.String,int,int,int,boolean,org.apache.logging.log4j.core.Layout,int,org.apache.logging.log4j.core.net.SocketOptions)"> |
| <h3>getSocketManager</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TcpSocketManager.html" title="class in org.apache.logging.log4j.core.net">TcpSocketManager</a></span> <span class="element-name">getSocketManager</span><wbr><span class="parameters">(<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> host, |
| int port, |
| int connectTimeoutMillis, |
| int reconnectDelayMillis, |
| boolean immediateFail, |
| <a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| int bufferSize, |
| <a href="SocketOptions.html" title="class in org.apache.logging.log4j.core.net">SocketOptions</a> socketOptions)</span></div> |
| <div class="block">Obtains a TcpSocketManager.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>host</code> - The host to connect to.</dd> |
| <dd><code>port</code> - The port on the host.</dd> |
| <dd><code>connectTimeoutMillis</code> - the connect timeout in milliseconds</dd> |
| <dd><code>reconnectDelayMillis</code> - The interval to pause between retries.</dd> |
| <dd><code>bufferSize</code> - The buffer size.</dd> |
| <dt>Returns:</dt> |
| <dd>A TcpSocketManager.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="write(byte[],int,int,boolean)"> |
| <h3>write</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">write</span><wbr><span class="parameters">(byte[] bytes, |
| int offset, |
| int length, |
| boolean immediateFlush)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../appender/OutputStreamManager.html#write(byte%5B%5D,int,int,boolean)">OutputStreamManager</a></code></span></div> |
| <div class="block">Some output streams synchronize writes while others do not. Synchronizing here insures that |
| log events won't be intertwined.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../appender/OutputStreamManager.html#write(byte%5B%5D,int,int,boolean)">write</a></code> in class <code><a href="../appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>bytes</code> - The serialized Log event.</dd> |
| <dd><code>offset</code> - The offset into the byte array.</dd> |
| <dd><code>length</code> - The number of bytes to write.</dd> |
| <dd><code>immediateFlush</code> - flushes immediately after writing.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="closeOutputStream()"> |
| <h3>closeOutputStream</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">closeOutputStream</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../appender/OutputStreamManager.html#closeOutputStream()">closeOutputStream</a></code> in class <code><a href="../appender/OutputStreamManager.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamManager</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConnectTimeoutMillis()"> |
| <h3>getConnectTimeoutMillis</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getConnectTimeoutMillis</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContentFormat()"> |
| <h3>getContentFormat</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/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><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">getContentFormat</span>()</div> |
| <div class="block">Gets this TcpSocketManager's content format. Specified by: |
| <ul> |
| <li>Key: "protocol" Value: "tcp"</li> |
| <li>Key: "direction" Value: "out"</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractSocketManager.html#getContentFormat()">getContentFormat</a></code> in class <code><a href="AbstractSocketManager.html" title="class in org.apache.logging.log4j.core.net">AbstractSocketManager</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Map of content format keys supporting TcpSocketManager</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createSocket(java.net.InetSocketAddress)"> |
| <h3>createSocket</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html" title="class or interface in java.net" class="external-link">Socket</a></span> <span class="element-name">createSocket</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a> socketAddress)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createSocket(java.net.InetSocketAddress,org.apache.logging.log4j.core.net.SocketOptions,int)"> |
| <h3>createSocket</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html" title="class or interface in java.net" class="external-link">Socket</a></span> <span class="element-name">createSocket</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a> socketAddress, |
| <a href="SocketOptions.html" title="class in org.apache.logging.log4j.core.net">SocketOptions</a> socketOptions, |
| int connectTimeoutMillis)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setHostResolver(org.apache.logging.log4j.core.net.TcpSocketManager.HostResolver)"> |
| <h3>setHostResolver</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">setHostResolver</span><wbr><span class="parameters">(<a href="TcpSocketManager.HostResolver.html" title="class in org.apache.logging.log4j.core.net">TcpSocketManager.HostResolver</a> resolver)</span></div> |
| <div class="block">This method is only for unit testing. It is not Thread-safe.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>resolver</code> - the HostResolver.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSocketOptions()"> |
| <h3>getSocketOptions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SocketOptions.html" title="class in org.apache.logging.log4j.core.net">SocketOptions</a></span> <span class="element-name">getSocketOptions</span>()</div> |
| <div class="block">USE AT YOUR OWN RISK, method is public for testing purpose only for now.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSocket()"> |
| <h3>getSocket</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/net/Socket.html" title="class or interface in java.net" class="external-link">Socket</a></span> <span class="element-name">getSocket</span>()</div> |
| <div class="block">USE AT YOUR OWN RISK, method is public for testing purpose only for now.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReconnectionDelayMillis()"> |
| <h3>getReconnectionDelayMillis</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getReconnectionDelayMillis</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</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">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><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></code></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> |
