Google Git
Sign in
apache / logging-site / cee98829d419cad30a3063736b22fd728b156bc1 / . / docs / chainsaw / chainsaw_20060302 / apidocs / org / apache / log4j / net / SocketReceiver.html
blob: f4656652d38d314aea44e45b39347bb927fdb3a0 [file] [log] [blame]
<!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>SocketReceiver (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="SocketReceiver (Apache Chainsaw 2.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":42,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":42,"i14":10,"i15":10,"i16":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/SocketReceiver.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/SocketNodeEventListener.html" title="interface in org.apache.log4j.net"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/log4j/net/UDPAppender.html" title="class in org.apache.log4j.net"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/net/SocketReceiver.html" target="_top">Frames</a></li>
<li><a href="SocketReceiver.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 SocketReceiver" class="title">Class SocketReceiver</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><a href="../../../../org/apache/log4j/spi/ComponentBase.html" title="class in org.apache.log4j.spi">org.apache.log4j.spi.ComponentBase</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html" title="class in org.apache.log4j.plugins">org.apache.log4j.plugins.PluginSkeleton</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">org.apache.log4j.plugins.Receiver</a></li>
<li>
<ul class="inheritance">
<li>org.apache.log4j.net.SocketReceiver</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>, <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>, <a href="../../../../org/apache/log4j/plugins/Pauseable.html" title="interface in org.apache.log4j.plugins">Pauseable</a>, <a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a>, <a href="../../../../org/apache/log4j/spi/Component.html" title="interface in org.apache.log4j.spi">Component</a>, org.apache.log4j.spi.OptionHandler, <a href="../../../../org/apache/log4j/spi/Thresholdable.html" title="interface in org.apache.log4j.spi">Thresholdable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SocketReceiver</span>
extends <a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">Receiver</a>
implements <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>, <a href="../../../../org/apache/log4j/net/PortBased.html" title="interface in org.apache.log4j.net">PortBased</a>, <a href="../../../../org/apache/log4j/plugins/Pauseable.html" title="interface in org.apache.log4j.plugins">Pauseable</a></pre>
<div class="block">SocketReceiver receives a remote logging event on a configured
socket and "posts" it to a LoggerRepository as if the event was
generated locally. This class is designed to receive events from
the SocketAppender class (or classes that send compatible events).
<p>Once the event has been "posted", it will be handled by the
appenders currently configured in the LoggerRespository.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mark Womack, Scott Deboy (sdeboy@apache.org), Paul Smith (psmith@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">&nbsp;</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>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/SocketReceiver.html#port">port</a></span></code>
<div class="block">Port.</div>
</td>
</tr>
<tr class="rowColor">
<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/SocketReceiver.html#ZONE">ZONE</a></span></code>
<div class="block">The MulticastDNS zone advertised by a SocketReceiver</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.plugins.Receiver">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.log4j.plugins.<a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">Receiver</a></h3>
<code><a href="../../../../org/apache/log4j/plugins/Receiver.html#thresholdLevel">thresholdLevel</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.plugins.PluginSkeleton">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.log4j.plugins.<a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html" title="class in org.apache.log4j.plugins">PluginSkeleton</a></h3>
<code><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#active">active</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#name">name</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.spi.ComponentBase">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.log4j.spi.<a href="../../../../org/apache/log4j/spi/ComponentBase.html" title="class in org.apache.log4j.spi">ComponentBase</a></h3>
<code><a href="../../../../org/apache/log4j/spi/ComponentBase.html#repository">repository</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</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/SocketReceiver.html#SocketReceiver--">SocketReceiver</a></span>()</code>
<div class="block">Create new instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/SocketReceiver.html#SocketReceiver-int-">SocketReceiver</a></span>(int&nbsp;p)</code>
<div class="block">Create new instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/SocketReceiver.html#SocketReceiver-int-org.apache.log4j.spi.LoggerRepository-">SocketReceiver</a></span>(int&nbsp;p,
org.apache.log4j.spi.LoggerRepository&nbsp;repo)</code>
<div class="block">Create new instance.</div>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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/SocketReceiver.html#activateOptions--">activateOptions</a></span>()</code>
<div class="block">Starts the SocketReceiver with the current options.</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/SocketReceiver.html#addSocketNodeEventListener-org.apache.log4j.net.SocketNodeEventListener-">addSocketNodeEventListener</a></span>(<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</a>&nbsp;l)</code>
<div class="block">Adds the listener to the list of listeners to be notified of the
respective event.</div>
</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/SocketReceiver.html#doPost-org.apache.log4j.spi.LoggingEvent-">doPost</a></span>(org.apache.log4j.spi.LoggingEvent&nbsp;event)</code>
<div class="block">Posts the logging event to a logger in the configured logger
repository.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/SocketReceiver.html#getConnectedSocketDetails--">getConnectedSocketDetails</a></span>()</code>
<div class="block">Returns a Vector of SocketDetail representing the IP/Domain name
of the currently connected sockets that this receiver has
been responsible for creating.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/SocketReceiver.html#getListener--">getListener</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This receiver now supports multiple listeners</span></div>
</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/SocketReceiver.html#getPort--">getPort</a></span>()</code>
<div class="block">Returns the Port # that this net based thing is using.</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/SocketReceiver.html#isAdvertiseViaMulticastDNS--">isAdvertiseViaMulticastDNS</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/SocketReceiver.html#isEquivalent-org.apache.log4j.plugins.Plugin-">isEquivalent</a></span>(<a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a>&nbsp;testPlugin)</code>
<div class="block">Returns true if the receiver is the same class and they are
configured for the same properties, and super class also considers
them to be equivalent.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/SocketReceiver.html#isPaused--">isPaused</a></span>()</code>
<div class="block">Get paused state.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/SocketReceiver.html#removeSocketNodeEventListener-org.apache.log4j.net.SocketNodeEventListener-">removeSocketNodeEventListener</a></span>(<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</a>&nbsp;l)</code>
<div class="block">Removes the registered Listener from this instances list of
listeners.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/SocketReceiver.html#run--">run</a></span>()</code>
<div class="block">Loop, accepting new socket connections.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/SocketReceiver.html#setActive-boolean-">setActive</a></span>(boolean&nbsp;b)</code>
<div class="block">Sets the flag to indicate if receiver is active or not.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/net/SocketReceiver.html#setAdvertiseViaMulticastDNS-boolean-">setAdvertiseViaMulticastDNS</a></span>(boolean&nbsp;advertiseViaMulticastDNS)</code>&nbsp;</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/SocketReceiver.html#setListener-org.apache.log4j.net.SocketNodeEventListener-">setListener</a></span>(<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</a>&nbsp;l)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This receiver now supports multiple listeners and
so this method simply removes the listener (if there already)
and readds it to the list.
The passed listener will also be returned via the getListener()
method still, but this is also deprecated</span></div>
</div>
</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/SocketReceiver.html#setPaused-boolean-">setPaused</a></span>(boolean&nbsp;b)</code>
<div class="block">Set paused state.</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/SocketReceiver.html#setPort-int-">setPort</a></span>(int&nbsp;p)</code></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/SocketReceiver.html#shutdown--">shutdown</a></span>()</code>
<div class="block">Called when the receiver should be stopped.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.plugins.Receiver">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.log4j.plugins.<a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">Receiver</a></h3>
<code><a href="../../../../org/apache/log4j/plugins/Receiver.html#getThreshold--">getThreshold</a>, <a href="../../../../org/apache/log4j/plugins/Receiver.html#isAsSevereAsThreshold-org.apache.log4j.Level-">isAsSevereAsThreshold</a>, <a href="../../../../org/apache/log4j/plugins/Receiver.html#setThreshold-org.apache.log4j.Level-">setThreshold</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.plugins.PluginSkeleton">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.log4j.plugins.<a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html" title="class in org.apache.log4j.plugins">PluginSkeleton</a></h3>
<code><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#addPropertyChangeListener-java.beans.PropertyChangeListener-">addPropertyChangeListener</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#addPropertyChangeListener-java.lang.String-java.beans.PropertyChangeListener-">addPropertyChangeListener</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#firePropertyChange-java.beans.PropertyChangeEvent-">firePropertyChange</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#firePropertyChange-java.lang.String-boolean-boolean-">firePropertyChange</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#firePropertyChange-java.lang.String-int-int-">firePropertyChange</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#firePropertyChange-java.lang.String-java.lang.Object-java.lang.Object-">firePropertyChange</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#getLoggerRepository--">getLoggerRepository</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#getName--">getName</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#isActive--">isActive</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#removePropertyChangeListener-java.beans.PropertyChangeListener-">removePropertyChangeListener</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#removePropertyChangeListener-java.lang.String-java.beans.PropertyChangeListener-">removePropertyChangeListener</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#setLoggerRepository-org.apache.log4j.spi.LoggerRepository-">setLoggerRepository</a>, <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#setName-java.lang.String-">setName</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.spi.ComponentBase">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.log4j.spi.<a href="../../../../org/apache/log4j/spi/ComponentBase.html" title="class in org.apache.log4j.spi">ComponentBase</a></h3>
<code><a href="../../../../org/apache/log4j/spi/ComponentBase.html#getLogger--">getLogger</a>, <a href="../../../../org/apache/log4j/spi/ComponentBase.html#getNonFloodingLogger--">getNonFloodingLogger</a>, <a href="../../../../org/apache/log4j/spi/ComponentBase.html#resetErrorCount--">resetErrorCount</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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#finalize--" title="class or interface in java.lang">finalize</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&nbsp;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>, <a href="../../../../org/apache/log4j/net/NetworkBased.html#isActive--">isActive</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="port">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>port</h4>
<pre>protected&nbsp;int port</pre>
<div class="block">Port.</div>
</li>
</ul>
<a name="ZONE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ZONE</h4>
<pre>public static final&nbsp;<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 SocketReceiver</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.log4j.net.SocketReceiver.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="SocketReceiver--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SocketReceiver</h4>
<pre>public&nbsp;SocketReceiver()</pre>
<div class="block">Create new instance.</div>
</li>
</ul>
<a name="SocketReceiver-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SocketReceiver</h4>
<pre>public&nbsp;SocketReceiver(int&nbsp;p)</pre>
<div class="block">Create new instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p</code> - port</dd>
</dl>
</li>
</ul>
<a name="SocketReceiver-int-org.apache.log4j.spi.LoggerRepository-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SocketReceiver</h4>
<pre>public&nbsp;SocketReceiver(int&nbsp;p,
org.apache.log4j.spi.LoggerRepository&nbsp;repo)</pre>
<div class="block">Create new instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p</code> - port</dd>
<dd><code>repo</code> - logger repository</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getPort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPort</h4>
<pre>public&nbsp;int&nbsp;getPort()</pre>
<div class="block">Returns the Port # that this net based thing is using.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/log4j/net/PortBased.html#getPort--">getPort</a></code>&nbsp;in interface&nbsp;<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="setPort-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPort</h4>
<pre>public&nbsp;void&nbsp;setPort(int&nbsp;p)</pre>
</li>
</ul>
<a name="isEquivalent-org.apache.log4j.plugins.Plugin-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEquivalent</h4>
<pre>public&nbsp;boolean&nbsp;isEquivalent(<a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a>&nbsp;testPlugin)</pre>
<div class="block">Returns true if the receiver is the same class and they are
configured for the same properties, and super class also considers
them to be equivalent. This is used by PluginRegistry when determining
if the a similarly configured receiver is being started.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#isEquivalent-org.apache.log4j.plugins.Plugin-">isEquivalent</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html#isEquivalent-org.apache.log4j.plugins.Plugin-">isEquivalent</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html" title="class in org.apache.log4j.plugins">PluginSkeleton</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>testPlugin</code> - The plugin to test equivalency against.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean True if the testPlugin is equivalent to this plugin.</dd>
</dl>
</li>
</ul>
<a name="activateOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>activateOptions</h4>
<pre>public&nbsp;void&nbsp;activateOptions()</pre>
<div class="block">Starts the SocketReceiver with the current options.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>activateOptions</code>&nbsp;in interface&nbsp;<code>org.apache.log4j.spi.OptionHandler</code></dd>
</dl>
</li>
</ul>
<a name="shutdown--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdown</h4>
<pre>public&nbsp;void&nbsp;shutdown()</pre>
<div class="block">Called when the receiver should be stopped. Closes the
server socket and all of the open sockets.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/log4j/plugins/Plugin.html#shutdown--">shutdown</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/log4j/plugins/Plugin.html" title="interface in org.apache.log4j.plugins">Plugin</a></code></dd>
</dl>
</li>
</ul>
<a name="setActive-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setActive</h4>
<pre>protected&nbsp;void&nbsp;setActive(boolean&nbsp;b)</pre>
<div class="block">Sets the flag to indicate if receiver is active or not.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - new value</dd>
</dl>
</li>
</ul>
<a name="setAdvertiseViaMulticastDNS-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAdvertiseViaMulticastDNS</h4>
<pre>public&nbsp;void&nbsp;setAdvertiseViaMulticastDNS(boolean&nbsp;advertiseViaMulticastDNS)</pre>
</li>
</ul>
<a name="isAdvertiseViaMulticastDNS--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAdvertiseViaMulticastDNS</h4>
<pre>public&nbsp;boolean&nbsp;isAdvertiseViaMulticastDNS()</pre>
</li>
</ul>
<a name="run--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;void&nbsp;run()</pre>
<div class="block">Loop, accepting new socket connections.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Runnable.html?is-external=true#run--" title="class or interface in java.lang">run</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></dd>
</dl>
</li>
</ul>
<a name="getConnectedSocketDetails--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectedSocketDetails</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;getConnectedSocketDetails()</pre>
<div class="block">Returns a Vector of SocketDetail representing the IP/Domain name
of the currently connected sockets that this receiver has
been responsible for creating.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Vector of SocketDetails</dd>
</dl>
</li>
</ul>
<a name="getListener--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getListener</h4>
<pre>public&nbsp;<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</a>&nbsp;getListener()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This receiver now supports multiple listeners</span></div>
<div class="block">Returns the currently configured SocketNodeEventListener that
will be automatically set for each SocketNode created.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SocketNodeEventListener currently configured</dd>
</dl>
</li>
</ul>
<a name="addSocketNodeEventListener-org.apache.log4j.net.SocketNodeEventListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSocketNodeEventListener</h4>
<pre>public&nbsp;void&nbsp;addSocketNodeEventListener(<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</a>&nbsp;l)</pre>
<div class="block">Adds the listener to the list of listeners to be notified of the
respective event.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>l</code> - the listener to add to the list</dd>
</dl>
</li>
</ul>
<a name="removeSocketNodeEventListener-org.apache.log4j.net.SocketNodeEventListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeSocketNodeEventListener</h4>
<pre>public&nbsp;void&nbsp;removeSocketNodeEventListener(<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</a>&nbsp;l)</pre>
<div class="block">Removes the registered Listener from this instances list of
listeners. If the listener has not been registered, then invoking
this method has no effect.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>l</code> - the SocketNodeEventListener to remove</dd>
</dl>
</li>
</ul>
<a name="setListener-org.apache.log4j.net.SocketNodeEventListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setListener</h4>
<pre>public&nbsp;void&nbsp;setListener(<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</a>&nbsp;l)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This receiver now supports multiple listeners and
so this method simply removes the listener (if there already)
and readds it to the list.
The passed listener will also be returned via the getListener()
method still, but this is also deprecated</span></div>
<div class="block">Sets the SocketNodeEventListener that will be used for each
created SocketNode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>l</code> - the listener to set on each creation of a SocketNode</dd>
</dl>
</li>
</ul>
<a name="isPaused--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPaused</h4>
<pre>public&nbsp;boolean&nbsp;isPaused()</pre>
<div class="block">Get paused state.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/log4j/plugins/Pauseable.html#isPaused--">isPaused</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/log4j/plugins/Pauseable.html" title="interface in org.apache.log4j.plugins">Pauseable</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>paused state.</dd>
</dl>
</li>
</ul>
<a name="setPaused-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPaused</h4>
<pre>public&nbsp;void&nbsp;setPaused(boolean&nbsp;b)</pre>
<div class="block">Set paused state.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/log4j/plugins/Pauseable.html#setPaused-boolean-">setPaused</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/log4j/plugins/Pauseable.html" title="interface in org.apache.log4j.plugins">Pauseable</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - new value</dd>
</dl>
</li>
</ul>
<a name="doPost-org.apache.log4j.spi.LoggingEvent-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>doPost</h4>
<pre>public&nbsp;void&nbsp;doPost(org.apache.log4j.spi.LoggingEvent&nbsp;event)</pre>
<div class="block">Posts the logging event to a logger in the configured logger
repository.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/log4j/plugins/Receiver.html#doPost-org.apache.log4j.spi.LoggingEvent-">doPost</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/log4j/plugins/Receiver.html" title="class in org.apache.log4j.plugins">Receiver</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - the log event to post to the local log4j environment.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SocketReceiver.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/SocketNodeEventListener.html" title="interface in org.apache.log4j.net"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/log4j/net/UDPAppender.html" title="class in org.apache.log4j.net"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/net/SocketReceiver.html" target="_top">Frames</a></li>
<li><a href="SocketReceiver.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 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>