| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_131) on Wed Aug 02 06:39:21 CEST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>MulticastAppender (Apache Chainsaw 2.1.0-SNAPSHOT API)</title> |
| <meta name="date" content="2017-08-02"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MulticastAppender (Apache Chainsaw 2.1.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MulticastAppender.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/log4j/net/JMSReceiverBeanInfo.html" title="class in org.apache.log4j.net"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/log4j/net/MulticastReceiver.html" title="class in org.apache.log4j.net"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/log4j/net/MulticastAppender.html" target="_top">Frames</a></li> |
| <li><a href="MulticastAppender.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><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="subNavList"> |
| <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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.log4j.net</div> |
| <h2 title="Class MulticastAppender" class="title">Class MulticastAppender</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.log4j.AppenderSkeleton</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.log4j.net.MulticastAppender</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.apache.log4j.Appender, <a href="../../../../org/apache/log4j/net/NetworkBased.html" title="interface in org.apache.log4j.net">NetworkBased</a>, <a href="../../../../org/apache/log4j/net/PortBased.html" title="interface in org.apache.log4j.net">PortBased</a>, org.apache.log4j.spi.OptionHandler</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">MulticastAppender</span> |
| extends org.apache.log4j.AppenderSkeleton |
| implements <a href="../../../../org/apache/log4j/net/PortBased.html" title="interface in org.apache.log4j.net">PortBased</a></pre> |
| <div class="block">Multicast-based Appender. Works in conjunction with the MulticastReceiver, which expects |
| a LoggingEvent encoded using XMLLayout. |
| |
| Sends log information as a multicast datagrams. |
| |
| <p>Messages are not sent as LoggingEvent objects but as text after |
| applying XMLLayout. |
| |
| <p>The port and remoteHost properties can be set in configuration properties. |
| By setting the remoteHost to a broadcast address any number of clients can |
| listen for log messages. |
| |
| <p>This was inspired and really extended/copied from <code>SocketAppender</code>. Please |
| see the docs for the proper credit to the authors of that class.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="mailto:kbrown@versatilesolutions.com">Kevin Brown</a>, Scott Deboy <sdeboy@apache.org></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#ZONE">ZONE</a></span></code> |
| <div class="block">The MulticastDNS zone advertised by a MulticastAppender |
| the MulticastAppender also adds a 'multicastAddress' property with the multicast address value as a string</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.AppenderSkeleton"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.log4j.AppenderSkeleton</h3> |
| <code>closed, errorHandler, headFilter, layout, name, tailFilter, threshold</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#MulticastAppender--">MulticastAppender</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#activateOptions--">activateOptions</a></span>()</code> |
| <div class="block">Open the multicast sender for the <b>RemoteHost</b> and <b>Port</b>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#append-org.apache.log4j.spi.LoggingEvent-">append</a></span>(org.apache.log4j.spi.LoggingEvent event)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#cleanUp--">cleanUp</a></span>()</code> |
| <div class="block">Close the Socket and release the underlying |
| connector thread if it has been created</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#close--">close</a></span>()</code> |
| <div class="block">Close this appender.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#getApplication--">getApplication</a></span>()</code> |
| <div class="block">Returns value of the <b>App</b> option.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#getEncoding--">getEncoding</a></span>()</code> |
| <div class="block">Returns value of the <b>Encoding</b> option.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#getLocationInfo--">getLocationInfo</a></span>()</code> |
| <div class="block">Returns value of the <b>LocationInfo</b> option.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#getPort--">getPort</a></span>()</code> |
| <div class="block">Returns value of the <b>Port</b> option.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#getRemoteHost--">getRemoteHost</a></span>()</code> |
| <div class="block">Returns value of the <b>RemoteHost</b> option.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#getTimeToLive--">getTimeToLive</a></span>()</code> |
| <div class="block">Returns value of the <b>Time to Live</b> option.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#isActive--">isActive</a></span>()</code> |
| <div class="block">Get if item is active.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#isAdvertiseViaMulticastDNS--">isAdvertiseViaMulticastDNS</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#requiresLayout--">requiresLayout</a></span>()</code> |
| <div class="block">Gets whether appender requires a layout.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#setAdvertiseViaMulticastDNS-boolean-">setAdvertiseViaMulticastDNS</a></span>(boolean advertiseViaMulticastDNS)</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#setApplication-java.lang.String-">setApplication</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> app)</code> |
| <div class="block">The <b>App</b> option takes a string value which should be the name of the application getting logged.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#setEncoding-java.lang.String-">setEncoding</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</code> |
| <div class="block">The <b>Encoding</b> option specifies how the bytes are encoded.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#setLocationInfo-boolean-">setLocationInfo</a></span>(boolean locationInfo)</code> |
| <div class="block">The <b>LocationInfo</b> option takes a boolean value.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#setPort-int-">setPort</a></span>(int port)</code> |
| <div class="block">The <b>Port</b> option takes a positive integer representing |
| the port where multicast packets will be sent.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#setRemoteHost-java.lang.String-">setRemoteHost</a></span>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> host)</code> |
| <div class="block">The <b>RemoteHost</b> option takes a string value which should be |
| the host name or ipaddress to send the multicast packets.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/MulticastAppender.html#setTimeToLive-int-">setTimeToLive</a></span>(int timeToLive)</code> |
| <div class="block">The <b>Time to live</b> option takes a positive integer representing |
| the time to live value.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.AppenderSkeleton"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.log4j.AppenderSkeleton</h3> |
| <code>addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.net.NetworkBased"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.log4j.net.<a href="../../../../org/apache/log4j/net/NetworkBased.html" title="interface in org.apache.log4j.net">NetworkBased</a></h3> |
| <code><a href="../../../../org/apache/log4j/net/NetworkBased.html#getName--">getName</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="ZONE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ZONE</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ZONE</pre> |
| <div class="block">The MulticastDNS zone advertised by a MulticastAppender |
| the MulticastAppender also adds a 'multicastAddress' property with the multicast address value as a string</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.log4j.net.MulticastAppender.ZONE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="MulticastAppender--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MulticastAppender</h4> |
| <pre>public MulticastAppender()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="activateOptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>activateOptions</h4> |
| <pre>public void activateOptions()</pre> |
| <div class="block">Open the multicast sender for the <b>RemoteHost</b> and <b>Port</b>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>activateOptions</code> in interface <code>org.apache.log4j.spi.OptionHandler</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>activateOptions</code> in class <code>org.apache.log4j.AppenderSkeleton</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block">Close this appender. |
| <p>This will mark the appender as closed and |
| call then <a href="../../../../org/apache/log4j/net/MulticastAppender.html#cleanUp--"><code>cleanUp()</code></a> method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>org.apache.log4j.Appender</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cleanUp--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cleanUp</h4> |
| <pre>public void cleanUp()</pre> |
| <div class="block">Close the Socket and release the underlying |
| connector thread if it has been created</div> |
| </li> |
| </ul> |
| <a name="append-org.apache.log4j.spi.LoggingEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>append</h4> |
| <pre>public void append(org.apache.log4j.spi.LoggingEvent event)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>append</code> in class <code>org.apache.log4j.AppenderSkeleton</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRemoteHost-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRemoteHost</h4> |
| <pre>public void setRemoteHost(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> host)</pre> |
| <div class="block">The <b>RemoteHost</b> option takes a string value which should be |
| the host name or ipaddress to send the multicast packets.</div> |
| </li> |
| </ul> |
| <a name="getRemoteHost--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteHost</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRemoteHost()</pre> |
| <div class="block">Returns value of the <b>RemoteHost</b> option.</div> |
| </li> |
| </ul> |
| <a name="setLocationInfo-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocationInfo</h4> |
| <pre>public void setLocationInfo(boolean locationInfo)</pre> |
| <div class="block">The <b>LocationInfo</b> option takes a boolean value. If true, |
| the information sent to the remote host will include location |
| information. By default no location information is sent to the server.</div> |
| </li> |
| </ul> |
| <a name="getLocationInfo--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocationInfo</h4> |
| <pre>public boolean getLocationInfo()</pre> |
| <div class="block">Returns value of the <b>LocationInfo</b> option.</div> |
| </li> |
| </ul> |
| <a name="setEncoding-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEncoding</h4> |
| <pre>public void setEncoding(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</pre> |
| <div class="block">The <b>Encoding</b> option specifies how the bytes are encoded. If this option is not specified, |
| the System encoding is used.</div> |
| </li> |
| </ul> |
| <a name="getEncoding--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncoding</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getEncoding()</pre> |
| <div class="block">Returns value of the <b>Encoding</b> option.</div> |
| </li> |
| </ul> |
| <a name="setApplication-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setApplication</h4> |
| <pre>public void setApplication(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> app)</pre> |
| <div class="block">The <b>App</b> option takes a string value which should be the name of the application getting logged. |
| If property was already set (via system property), don't set here.</div> |
| </li> |
| </ul> |
| <a name="getApplication--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApplication</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getApplication()</pre> |
| <div class="block">Returns value of the <b>App</b> option.</div> |
| </li> |
| </ul> |
| <a name="setTimeToLive-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimeToLive</h4> |
| <pre>public void setTimeToLive(int timeToLive)</pre> |
| <div class="block">The <b>Time to live</b> option takes a positive integer representing |
| the time to live value.</div> |
| </li> |
| </ul> |
| <a name="getTimeToLive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeToLive</h4> |
| <pre>public int getTimeToLive()</pre> |
| <div class="block">Returns value of the <b>Time to Live</b> option.</div> |
| </li> |
| </ul> |
| <a name="setPort-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPort</h4> |
| <pre>public void setPort(int port)</pre> |
| <div class="block">The <b>Port</b> option takes a positive integer representing |
| the port where multicast packets will be sent.</div> |
| </li> |
| </ul> |
| <a name="getPort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPort</h4> |
| <pre>public int getPort()</pre> |
| <div class="block">Returns value of the <b>Port</b> option.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/net/PortBased.html#getPort--">getPort</a></code> in interface <code><a href="../../../../org/apache/log4j/net/PortBased.html" title="interface in org.apache.log4j.net">PortBased</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>int port number</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isActive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isActive</h4> |
| <pre>public boolean isActive()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/log4j/net/NetworkBased.html#isActive--">NetworkBased</a></code></span></div> |
| <div class="block">Get if item is active.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/log4j/net/NetworkBased.html#isActive--">isActive</a></code> in interface <code><a href="../../../../org/apache/log4j/net/NetworkBased.html" title="interface in org.apache.log4j.net">NetworkBased</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>if true, item is active.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="requiresLayout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiresLayout</h4> |
| <pre>public boolean requiresLayout()</pre> |
| <div class="block">Gets whether appender requires a layout.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>requiresLayout</code> in interface <code>org.apache.log4j.Appender</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>false</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAdvertiseViaMulticastDNS--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAdvertiseViaMulticastDNS</h4> |
| <pre>public boolean isAdvertiseViaMulticastDNS()</pre> |
| </li> |
| </ul> |
| <a name="setAdvertiseViaMulticastDNS-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setAdvertiseViaMulticastDNS</h4> |
| <pre>public void setAdvertiseViaMulticastDNS(boolean advertiseViaMulticastDNS)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MulticastAppender.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/log4j/net/JMSReceiverBeanInfo.html" title="class in org.apache.log4j.net"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/log4j/net/MulticastReceiver.html" title="class in org.apache.log4j.net"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/log4j/net/MulticastAppender.html" target="_top">Frames</a></li> |
| <li><a href="MulticastAppender.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><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="subNavList"> |
| <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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><p align="center">Copyright © 2002-2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache Chainsaw, Chainsaw, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p> |
| </body> |
| </html> |