logging-general mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From carn...@apache.org
Subject svn commit: r558362 [28/33] - in /logging/site/trunk/docs/log4j/companions/receivers: ./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/log4j/ apidocs/org/apache/log4j/db/ apidocs/org/apache/log4j/db/class-use/ apidocs/org/apache/log4j/db...
Date Sat, 21 Jul 2007 17:50:44 GMT
Added: logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketHubReceiver.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketHubReceiver.html?view=auto&rev=558362
==============================================================================
--- logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketHubReceiver.html (added)
+++ logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketHubReceiver.html Sat Jul 21 10:50:33 2007
@@ -0,0 +1,404 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>SocketHubReceiver xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/net/SocketHubReceiver.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a>   <em class="comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a>   <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a>   <em class="comment"> * the License.  You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a>   <em class="comment"> *</em>
+<a name="9" href="#9">9</a>   <em class="comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="10" href="#10">10</a>  <em class="comment"> *</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a>  <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a>  <em class="comment"> */</em>
+<a name="17" href="#17">17</a>  
+<a name="18" href="#18">18</a>  <strong>package</strong> org.apache.log4j.net;
+<a name="19" href="#19">19</a>  
+<a name="20" href="#20">20</a>  <strong>import</strong> org.apache.log4j.plugins.Plugin;
+<a name="21" href="#21">21</a>  <strong>import</strong> org.apache.log4j.plugins.Receiver;
+<a name="22" href="#22">22</a>  <strong>import</strong> org.apache.log4j.spi.LoggerRepository;
+<a name="23" href="#23">23</a>  
+<a name="24" href="#24">24</a>  <strong>import</strong> java.io.IOException;
+<a name="25" href="#25">25</a>  <strong>import</strong> java.net.Socket;
+<a name="26" href="#26">26</a>  <strong>import</strong> java.util.ArrayList;
+<a name="27" href="#27">27</a>  <strong>import</strong> java.util.Collections;
+<a name="28" href="#28">28</a>  <strong>import</strong> java.util.Iterator;
+<a name="29" href="#29">29</a>  <strong>import</strong> java.util.List;
+<a name="30" href="#30">30</a>  
+<a name="31" href="#31">31</a>  <em>/**<em>*</em></em>
+<a name="32" href="#32">32</a>  <em>  SocketHubReceiver receives a remote logging event on a configured</em>
+<a name="33" href="#33">33</a>  <em>  socket and "posts" it to a LoggerRepository as if the event was</em>
+<a name="34" href="#34">34</a>  <em>  generated locally. This class is designed to receive events from</em>
+<a name="35" href="#35">35</a>  <em>  the SocketHubAppender class (or classes that send compatible events).</em>
+<a name="36" href="#36">36</a>  
+<a name="37" href="#37">37</a>  <em>  &lt;p>Once the event has been "posted", it will be handled by the</em>
+<a name="38" href="#38">38</a>  <em>  appenders currently configured in the LoggerRespository.</em>
+<a name="39" href="#39">39</a>  
+<a name="40" href="#40">40</a>  <em>  @author Mark Womack</em>
+<a name="41" href="#41">41</a>  <em>  @author Ceki G&amp;uuml;lc&amp;uuml;</em>
+<a name="42" href="#42">42</a>  <em>  @author Paul Smith (psmith@apache.org)</em>
+<a name="43" href="#43">43</a>  <em>  @since 1.3</em>
+<a name="44" href="#44">44</a>  <em>*/</em>
+<a name="45" href="#45">45</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/log4j/net/SocketHubReceiver.html">SocketHubReceiver</a>
+<a name="46" href="#46">46</a>  <strong>extends</strong> Receiver implements SocketNodeEventListener, <a href="../../../../org/apache/log4j/net/PortBased.html">PortBased</a> {
+<a name="47" href="#47">47</a>  
+<a name="48" href="#48">48</a>      <em>/**<em>*</em></em>
+<a name="49" href="#49">49</a>  <em>     * Default reconnection delay.</em>
+<a name="50" href="#50">50</a>  <em>     */</em>
+<a name="51" href="#51">51</a>    <strong>static</strong> <strong>final</strong> <strong>int</strong> DEFAULT_RECONNECTION_DELAY   = 30000;
+<a name="52" href="#52">52</a>  
+<a name="53" href="#53">53</a>      <em>/**<em>*</em></em>
+<a name="54" href="#54">54</a>  <em>     * Host.</em>
+<a name="55" href="#55">55</a>  <em>     */</em>
+<a name="56" href="#56">56</a>    <strong>protected</strong> String host;
+<a name="57" href="#57">57</a>  
+<a name="58" href="#58">58</a>      <em>/**<em>*</em></em>
+<a name="59" href="#59">59</a>  <em>     * Port.</em>
+<a name="60" href="#60">60</a>  <em>     */</em>
+<a name="61" href="#61">61</a>    <strong>protected</strong> <strong>int</strong> port;
+<a name="62" href="#62">62</a>      <em>/**<em>*</em></em>
+<a name="63" href="#63">63</a>  <em>     * Reconnection delay.</em>
+<a name="64" href="#64">64</a>  <em>     */</em>
+<a name="65" href="#65">65</a>    <strong>protected</strong> <strong>int</strong> reconnectionDelay = DEFAULT_RECONNECTION_DELAY;
+<a name="66" href="#66">66</a>  
+<a name="67" href="#67">67</a>      <em>/**<em>*</em></em>
+<a name="68" href="#68">68</a>  <em>     * Active.</em>
+<a name="69" href="#69">69</a>  <em>     */</em>
+<a name="70" href="#70">70</a>    <strong>protected</strong> <strong>boolean</strong> active = false;
+<a name="71" href="#71">71</a>  
+<a name="72" href="#72">72</a>      <em>/**<em>*</em></em>
+<a name="73" href="#73">73</a>  <em>     * Connector.</em>
+<a name="74" href="#74">74</a>  <em>     */</em>
+<a name="75" href="#75">75</a>    <strong>protected</strong> Connector connector;
+<a name="76" href="#76">76</a>  
+<a name="77" href="#77">77</a>      <em>/**<em>*</em></em>
+<a name="78" href="#78">78</a>  <em>     * Socket.</em>
+<a name="79" href="#79">79</a>  <em>     */</em>
+<a name="80" href="#80">80</a>    <strong>protected</strong> Socket socket;
+<a name="81" href="#81">81</a>  
+<a name="82" href="#82">82</a>      <em>/**<em>*</em></em>
+<a name="83" href="#83">83</a>  <em>     * Listener list.</em>
+<a name="84" href="#84">84</a>  <em>     */</em>
+<a name="85" href="#85">85</a>    <strong>private</strong> List listenerList = Collections.synchronizedList(<strong>new</strong> ArrayList());
+<a name="86" href="#86">86</a>  
+<a name="87" href="#87">87</a>      <em>/**<em>*</em></em>
+<a name="88" href="#88">88</a>  <em>     * Create new instance.</em>
+<a name="89" href="#89">89</a>  <em>     */</em>
+<a name="90" href="#90">90</a>    <strong>public</strong> <a href="../../../../org/apache/log4j/net/SocketHubReceiver.html">SocketHubReceiver</a>() {
+<a name="91" href="#91">91</a>       <strong>super</strong>();
+<a name="92" href="#92">92</a>    }
+<a name="93" href="#93">93</a>  
+<a name="94" href="#94">94</a>      <em>/**<em>*</em></em>
+<a name="95" href="#95">95</a>  <em>     * Create new instance.</em>
+<a name="96" href="#96">96</a>  <em>     * @param h host</em>
+<a name="97" href="#97">97</a>  <em>     * @param p port</em>
+<a name="98" href="#98">98</a>  <em>     */</em>
+<a name="99" href="#99">99</a>    <strong>public</strong> <a href="../../../../org/apache/log4j/net/SocketHubReceiver.html">SocketHubReceiver</a>(<strong>final</strong> String h,
+<a name="100" href="#100">100</a>                            <strong>final</strong> <strong>int</strong> p) {
+<a name="101" href="#101">101</a>     <strong>super</strong>();
+<a name="102" href="#102">102</a>     host = h;
+<a name="103" href="#103">103</a>     port = p;
+<a name="104" href="#104">104</a>   }
+<a name="105" href="#105">105</a> 
+<a name="106" href="#106">106</a>     <em>/**<em>*</em></em>
+<a name="107" href="#107">107</a> <em>     * Create new instance.</em>
+<a name="108" href="#108">108</a> <em>     * @param h host</em>
+<a name="109" href="#109">109</a> <em>     * @param p port</em>
+<a name="110" href="#110">110</a> <em>     * @param repo logger repository</em>
+<a name="111" href="#111">111</a> <em>     */</em>
+<a name="112" href="#112">112</a>   <strong>public</strong> <a href="../../../../org/apache/log4j/net/SocketHubReceiver.html">SocketHubReceiver</a>(<strong>final</strong> String h,
+<a name="113" href="#113">113</a>                            <strong>final</strong> <strong>int</strong> p,
+<a name="114" href="#114">114</a>                            <strong>final</strong> LoggerRepository repo) {
+<a name="115" href="#115">115</a>     <strong>super</strong>();
+<a name="116" href="#116">116</a>     host = h;
+<a name="117" href="#117">117</a>     port = p;
+<a name="118" href="#118">118</a>     repository = repo;
+<a name="119" href="#119">119</a>   }
+<a name="120" href="#120">120</a> 
+<a name="121" href="#121">121</a>   <em>/**<em>*</em></em>
+<a name="122" href="#122">122</a> <em>   * Adds a SocketNodeEventListener to this receiver to be notified</em>
+<a name="123" href="#123">123</a> <em>   * of SocketNode events.</em>
+<a name="124" href="#124">124</a> <em>   * @param l listener</em>
+<a name="125" href="#125">125</a> <em>   */</em>
+<a name="126" href="#126">126</a>   <strong>public</strong> <strong>void</strong> addSocketNodeEventListener(<strong>final</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> l) {
+<a name="127" href="#127">127</a>     listenerList.add(l);
+<a name="128" href="#128">128</a>   }
+<a name="129" href="#129">129</a> 
+<a name="130" href="#130">130</a>   <em>/**<em>*</em></em>
+<a name="131" href="#131">131</a> <em>   * Removes a specific SocketNodeEventListener from this instance</em>
+<a name="132" href="#132">132</a> <em>   * so that it will no  longer be notified of SocketNode events.</em>
+<a name="133" href="#133">133</a> <em>   * @param l listener</em>
+<a name="134" href="#134">134</a> <em>   */</em>
+<a name="135" href="#135">135</a>   <strong>public</strong> <strong>void</strong> removeSocketNodeEventListener(
+<a name="136" href="#136">136</a>           <strong>final</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> l) {
+<a name="137" href="#137">137</a>     listenerList.remove(l);
+<a name="138" href="#138">138</a>   }
+<a name="139" href="#139">139</a> 
+<a name="140" href="#140">140</a>   <em>/**<em>*</em></em>
+<a name="141" href="#141">141</a> <em>    Get the remote host to connect to for logging events.</em>
+<a name="142" href="#142">142</a> <em>    @return host</em>
+<a name="143" href="#143">143</a> <em>   */</em>
+<a name="144" href="#144">144</a>   <strong>public</strong> String getHost() {
+<a name="145" href="#145">145</a>     <strong>return</strong> host;
+<a name="146" href="#146">146</a>   }
+<a name="147" href="#147">147</a> 
+<a name="148" href="#148">148</a>   <em>/**<em>*</em></em>
+<a name="149" href="#149">149</a> <em>   * Configures the Host property, this will require activateOptions</em>
+<a name="150" href="#150">150</a> <em>   * to be called for this to take effect.</em>
+<a name="151" href="#151">151</a> <em>   * @param remoteHost address of remote host.</em>
+<a name="152" href="#152">152</a> <em>   */</em>
+<a name="153" href="#153">153</a>   <strong>public</strong> <strong>void</strong> setHost(<strong>final</strong> String remoteHost) {
+<a name="154" href="#154">154</a>     <strong>this</strong>.host = remoteHost;
+<a name="155" href="#155">155</a>   }
+<a name="156" href="#156">156</a>   <em>/**<em>*</em></em>
+<a name="157" href="#157">157</a> <em>    Set the remote host to connect to for logging events.</em>
+<a name="158" href="#158">158</a> <em>   Equivalent to setHost.</em>
+<a name="159" href="#159">159</a> <em>   @param remoteHost address of remote host.</em>
+<a name="160" href="#160">160</a> <em>   */</em>
+<a name="161" href="#161">161</a>   <strong>public</strong> <strong>void</strong> setPort(<strong>final</strong> String remoteHost) {
+<a name="162" href="#162">162</a>     host = remoteHost;
+<a name="163" href="#163">163</a>   }
+<a name="164" href="#164">164</a> 
+<a name="165" href="#165">165</a>   <em>/**<em>*</em></em>
+<a name="166" href="#166">166</a> <em>    Get the remote port to connect to for logging events.</em>
+<a name="167" href="#167">167</a> <em>   @return port</em>
+<a name="168" href="#168">168</a> <em>   */</em>
+<a name="169" href="#169">169</a>   <strong>public</strong> <strong>int</strong> getPort() {
+<a name="170" href="#170">170</a>     <strong>return</strong> port;
+<a name="171" href="#171">171</a>   }
+<a name="172" href="#172">172</a> 
+<a name="173" href="#173">173</a>   <em>/**<em>*</em></em>
+<a name="174" href="#174">174</a> <em>    Set the remote port to connect to for logging events.</em>
+<a name="175" href="#175">175</a> <em>    @param p port</em>
+<a name="176" href="#176">176</a> <em>   */</em>
+<a name="177" href="#177">177</a>   <strong>public</strong> <strong>void</strong> setPort(<strong>final</strong> <strong>int</strong> p) {
+<a name="178" href="#178">178</a>     <strong>this</strong>.port = p;
+<a name="179" href="#179">179</a>   }
+<a name="180" href="#180">180</a> 
+<a name="181" href="#181">181</a>   <em>/**<em>*</em></em>
+<a name="182" href="#182">182</a> <em>     The &lt;b>ReconnectionDelay&lt;/b> option takes a positive integer</em>
+<a name="183" href="#183">183</a> <em>     representing the number of milliseconds to wait between each</em>
+<a name="184" href="#184">184</a> <em>     failed connection attempt to the server. The default value of</em>
+<a name="185" href="#185">185</a> <em>     this option is 30000 which corresponds to 30 seconds.</em>
+<a name="186" href="#186">186</a> 
+<a name="187" href="#187">187</a> <em>     &lt;p>Setting this option to zero turns off reconnection</em>
+<a name="188" href="#188">188</a> <em>     capability.</em>
+<a name="189" href="#189">189</a> <em>   @param delay milliseconds to wait or zero to not reconnect.</em>
+<a name="190" href="#190">190</a> <em>   */</em>
+<a name="191" href="#191">191</a>   <strong>public</strong> <strong>void</strong> setReconnectionDelay(<strong>final</strong> <strong>int</strong> delay) {
+<a name="192" href="#192">192</a>     <strong>int</strong> oldValue = <strong>this</strong>.reconnectionDelay;
+<a name="193" href="#193">193</a>     <strong>this</strong>.reconnectionDelay = delay;
+<a name="194" href="#194">194</a>     firePropertyChange(<span class="string">"reconnectionDelay"</span>, oldValue, <strong>this</strong>.reconnectionDelay);
+<a name="195" href="#195">195</a>   }
+<a name="196" href="#196">196</a> 
+<a name="197" href="#197">197</a>   <em>/**<em>*</em></em>
+<a name="198" href="#198">198</a> <em>     Returns value of the &lt;b>ReconnectionDelay&lt;/b> option.</em>
+<a name="199" href="#199">199</a> <em>   @return value of reconnection delay option.</em>
+<a name="200" href="#200">200</a> <em>   */</em>
+<a name="201" href="#201">201</a>   <strong>public</strong> <strong>int</strong> getReconnectionDelay() {
+<a name="202" href="#202">202</a>     <strong>return</strong> reconnectionDelay;
+<a name="203" href="#203">203</a>   }
+<a name="204" href="#204">204</a> 
+<a name="205" href="#205">205</a>   <em>/**<em>*</em></em>
+<a name="206" href="#206">206</a> <em>   * Returns true if the receiver is the same class and they are</em>
+<a name="207" href="#207">207</a> <em>   * configured for the same properties, and super class also considers</em>
+<a name="208" href="#208">208</a> <em>   * them to be equivalent. This is used by PluginRegistry when determining</em>
+<a name="209" href="#209">209</a> <em>   * if the a similarly configured receiver is being started.</em>
+<a name="210" href="#210">210</a> <em>   *</em>
+<a name="211" href="#211">211</a> <em>   * @param testPlugin The plugin to test equivalency against.</em>
+<a name="212" href="#212">212</a> <em>   * @return boolean True if the testPlugin is equivalent to this plugin.</em>
+<a name="213" href="#213">213</a> <em>   */</em>
+<a name="214" href="#214">214</a>   <strong>public</strong> <strong>boolean</strong> isEquivalent(<strong>final</strong> Plugin testPlugin) {
+<a name="215" href="#215">215</a>     <strong>if</strong> (testPlugin != <strong>null</strong> &amp;&amp; testPlugin instanceof SocketHubReceiver) {
+<a name="216" href="#216">216</a>       <a href="../../../../org/apache/log4j/net/SocketHubReceiver.html">SocketHubReceiver</a> sReceiver = (SocketHubReceiver) testPlugin;
+<a name="217" href="#217">217</a> 
+<a name="218" href="#218">218</a>       <strong>return</strong> (port == sReceiver.getPort()
+<a name="219" href="#219">219</a>               &amp;&amp; host.equals(sReceiver.getHost())
+<a name="220" href="#220">220</a>               &amp;&amp; reconnectionDelay == sReceiver.getReconnectionDelay()
+<a name="221" href="#221">221</a>               &amp;&amp; <strong>super</strong>.isEquivalent(testPlugin));
+<a name="222" href="#222">222</a>     }
+<a name="223" href="#223">223</a>     <strong>return</strong> false;
+<a name="224" href="#224">224</a>   }
+<a name="225" href="#225">225</a> 
+<a name="226" href="#226">226</a>   <em>/**<em>*</em></em>
+<a name="227" href="#227">227</a> <em>    Returns true if this receiver is active.</em>
+<a name="228" href="#228">228</a> <em>   @return true if receiver is active</em>
+<a name="229" href="#229">229</a> <em>   */</em>
+<a name="230" href="#230">230</a>   <strong>public</strong> <strong>synchronized</strong> <strong>boolean</strong> isActive() {
+<a name="231" href="#231">231</a>     <strong>return</strong> active;
+<a name="232" href="#232">232</a>   }
+<a name="233" href="#233">233</a> 
+<a name="234" href="#234">234</a>   <em>/**<em>*</em></em>
+<a name="235" href="#235">235</a> <em>    Sets the flag to indicate if receiver is active or not.</em>
+<a name="236" href="#236">236</a> <em>   @param b new value</em>
+<a name="237" href="#237">237</a> <em>   */</em>
+<a name="238" href="#238">238</a>   <strong>protected</strong> <strong>synchronized</strong> <strong>void</strong> setActive(<strong>final</strong> <strong>boolean</strong> b) {
+<a name="239" href="#239">239</a>     active = b;
+<a name="240" href="#240">240</a>   }
+<a name="241" href="#241">241</a> 
+<a name="242" href="#242">242</a>   <em>/**<em>*</em></em>
+<a name="243" href="#243">243</a> <em>    Starts the SocketReceiver with the current options. */</em>
+<a name="244" href="#244">244</a>   <strong>public</strong> <strong>void</strong> activateOptions() {
+<a name="245" href="#245">245</a>     <strong>if</strong> (!isActive()) {
+<a name="246" href="#246">246</a>       setActive(<strong>true</strong>);
+<a name="247" href="#247">247</a>       fireConnector(false);
+<a name="248" href="#248">248</a>     }
+<a name="249" href="#249">249</a>   }
+<a name="250" href="#250">250</a> 
+<a name="251" href="#251">251</a>   <em>/**<em>*</em></em>
+<a name="252" href="#252">252</a> <em>    Called when the receiver should be stopped. Closes the socket */</em>
+<a name="253" href="#253">253</a>   <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> shutdown() {
+<a name="254" href="#254">254</a>     <em class="comment">// mark this as no longer running</em>
+<a name="255" href="#255">255</a>     active = false;
+<a name="256" href="#256">256</a> 
+<a name="257" href="#257">257</a>     <em class="comment">// close the socket</em>
+<a name="258" href="#258">258</a>     <strong>try</strong> {
+<a name="259" href="#259">259</a>       <strong>if</strong> (socket != <strong>null</strong>) {
+<a name="260" href="#260">260</a>         socket.close();
+<a name="261" href="#261">261</a>       }
+<a name="262" href="#262">262</a>     } <strong>catch</strong> (Exception e) {
+<a name="263" href="#263">263</a>       <em class="comment">// ignore for now</em>
+<a name="264" href="#264">264</a>     }
+<a name="265" href="#265">265</a>     socket = <strong>null</strong>;
+<a name="266" href="#266">266</a> 
+<a name="267" href="#267">267</a>     <em class="comment">// stop the connector</em>
+<a name="268" href="#268">268</a>     <strong>if</strong> (connector != <strong>null</strong>) {
+<a name="269" href="#269">269</a>       connector.interrupted = <strong>true</strong>;
+<a name="270" href="#270">270</a>       connector = <strong>null</strong>;  <em class="comment">// allow gc</em>
+<a name="271" href="#271">271</a>     }
+<a name="272" href="#272">272</a>   }
+<a name="273" href="#273">273</a> 
+<a name="274" href="#274">274</a>   <em>/**<em>*</em></em>
+<a name="275" href="#275">275</a> <em>    Listen for a socketClosedEvent from the SocketNode. Reopen the</em>
+<a name="276" href="#276">276</a> <em>    socket if this receiver is still active.</em>
+<a name="277" href="#277">277</a> <em>   @param e exception not used.</em>
+<a name="278" href="#278">278</a> <em>   */</em>
+<a name="279" href="#279">279</a>   <strong>public</strong> <strong>void</strong> socketClosedEvent(<strong>final</strong> Exception e) {
+<a name="280" href="#280">280</a>     <em class="comment">// we clear the connector object here</em>
+<a name="281" href="#281">281</a>     <em class="comment">// so that it actually does reconnect if the</em>
+<a name="282" href="#282">282</a>     <em class="comment">// remote socket dies.</em>
+<a name="283" href="#283">283</a>     connector = <strong>null</strong>;
+<a name="284" href="#284">284</a>     fireConnector(<strong>true</strong>);
+<a name="285" href="#285">285</a>   }
+<a name="286" href="#286">286</a> 
+<a name="287" href="#287">287</a>     <em>/**<em>*</em></em>
+<a name="288" href="#288">288</a> <em>     * Fire connectors.</em>
+<a name="289" href="#289">289</a> <em>     * @param isReconnect true if reconnect.</em>
+<a name="290" href="#290">290</a> <em>     */</em>
+<a name="291" href="#291">291</a>   <strong>private</strong> <strong>synchronized</strong> <strong>void</strong> fireConnector(<strong>final</strong> <strong>boolean</strong> isReconnect) {
+<a name="292" href="#292">292</a>     <strong>if</strong> (active &amp;&amp; connector == <strong>null</strong>) {
+<a name="293" href="#293">293</a>       getLogger().debug(<span class="string">"Starting a new connector thread."</span>);
+<a name="294" href="#294">294</a>       connector = <strong>new</strong> Connector(isReconnect);
+<a name="295" href="#295">295</a>       connector.setDaemon(<strong>true</strong>);
+<a name="296" href="#296">296</a>       connector.setPriority(Thread.MIN_PRIORITY);
+<a name="297" href="#297">297</a>       connector.start();
+<a name="298" href="#298">298</a>     }
+<a name="299" href="#299">299</a>   }
+<a name="300" href="#300">300</a> 
+<a name="301" href="#301">301</a>     <em>/**<em>*</em></em>
+<a name="302" href="#302">302</a> <em>     * Set socket.</em>
+<a name="303" href="#303">303</a> <em>     * @param newSocket new value for socket.</em>
+<a name="304" href="#304">304</a> <em>     */</em>
+<a name="305" href="#305">305</a>   <strong>private</strong> <strong>synchronized</strong> <strong>void</strong> setSocket(<strong>final</strong> Socket newSocket) {
+<a name="306" href="#306">306</a>     connector = <strong>null</strong>;
+<a name="307" href="#307">307</a>     socket = newSocket;
+<a name="308" href="#308">308</a>     SocketNode13 node = <strong>new</strong> SocketNode13(socket, <strong>this</strong>);
+<a name="309" href="#309">309</a>     node.addSocketNodeEventListener(<strong>this</strong>);
+<a name="310" href="#310">310</a> 
+<a name="311" href="#311">311</a>     <strong>synchronized</strong> (listenerList) {
+<a name="312" href="#312">312</a>         <strong>for</strong> (Iterator iter = listenerList.iterator(); iter.hasNext();) {
+<a name="313" href="#313">313</a>             <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> listener =
+<a name="314" href="#314">314</a>                     (<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a>) iter.next();
+<a name="315" href="#315">315</a>             node.addSocketNodeEventListener(listener);
+<a name="316" href="#316">316</a>         }
+<a name="317" href="#317">317</a>     }
+<a name="318" href="#318">318</a>     <strong>new</strong> Thread(node).start();
+<a name="319" href="#319">319</a>   }
+<a name="320" href="#320">320</a> 
+<a name="321" href="#321">321</a>   <em>/**<em>*</em></em>
+<a name="322" href="#322">322</a> <em>   The Connector will reconnect when the server becomes available</em>
+<a name="323" href="#323">323</a> <em>   again.  It does this by attempting to open a new connection every</em>
+<a name="324" href="#324">324</a> <em>   &lt;code>reconnectionDelay&lt;/code> milliseconds.</em>
+<a name="325" href="#325">325</a> 
+<a name="326" href="#326">326</a> <em>   &lt;p>It stops trying whenever a connection is established. It will</em>
+<a name="327" href="#327">327</a> <em>   restart to try reconnect to the server when previpously open</em>
+<a name="328" href="#328">328</a> <em>   connection is droppped.</em>
+<a name="329" href="#329">329</a> 
+<a name="330" href="#330">330</a> <em>   @author  Ceki G&amp;uuml;lc&amp;uuml;</em>
+<a name="331" href="#331">331</a> <em>   */</em>
+<a name="332" href="#332">332</a>   <strong>private</strong> <strong>final</strong> <strong>class</strong> Connector <strong>extends</strong> Thread {
+<a name="333" href="#333">333</a> 
+<a name="334" href="#334">334</a>       <em>/**<em>*</em></em>
+<a name="335" href="#335">335</a> <em>       * Interruption status.</em>
+<a name="336" href="#336">336</a> <em>       */</em>
+<a name="337" href="#337">337</a>     <strong>boolean</strong> interrupted = false;
+<a name="338" href="#338">338</a>       <em>/**<em>*</em></em>
+<a name="339" href="#339">339</a> <em>       * If true, then delay on next iteration.</em>
+<a name="340" href="#340">340</a> <em>       */</em>
+<a name="341" href="#341">341</a>     <strong>boolean</strong> doDelay;
+<a name="342" href="#342">342</a> 
+<a name="343" href="#343">343</a>       <em>/**<em>*</em></em>
+<a name="344" href="#344">344</a> <em>       * Create new instance.</em>
+<a name="345" href="#345">345</a> <em>       * @param isReconnect true if reconnecting.</em>
+<a name="346" href="#346">346</a> <em>       */</em>
+<a name="347" href="#347">347</a>     <strong>public</strong> Connector(<strong>final</strong> <strong>boolean</strong> isReconnect) {
+<a name="348" href="#348">348</a>       <strong>super</strong>();
+<a name="349" href="#349">349</a>       doDelay = isReconnect;
+<a name="350" href="#350">350</a>     }
+<a name="351" href="#351">351</a> 
+<a name="352" href="#352">352</a>       <em>/**<em>*</em></em>
+<a name="353" href="#353">353</a> <em>       * Attempt to connect until interrupted.</em>
+<a name="354" href="#354">354</a> <em>       */</em>
+<a name="355" href="#355">355</a>     <strong>public</strong> <strong>void</strong> run() {
+<a name="356" href="#356">356</a>       <strong>while</strong> (!interrupted) {
+<a name="357" href="#357">357</a>         <strong>try</strong> {
+<a name="358" href="#358">358</a>           <strong>if</strong> (doDelay) {
+<a name="359" href="#359">359</a>             getLogger().debug(<span class="string">"waiting for "</span> + reconnectionDelay
+<a name="360" href="#360">360</a>               + <span class="string">" milliseconds before reconnecting."</span>);
+<a name="361" href="#361">361</a>             sleep(reconnectionDelay);
+<a name="362" href="#362">362</a>           }
+<a name="363" href="#363">363</a>           doDelay = <strong>true</strong>;
+<a name="364" href="#364">364</a>           getLogger().debug(<span class="string">"Attempting connection to "</span> + host);
+<a name="365" href="#365">365</a>           Socket s = <strong>new</strong> Socket(host, port);
+<a name="366" href="#366">366</a>           setSocket(s);
+<a name="367" href="#367">367</a>           getLogger().debug(
+<a name="368" href="#368">368</a>                   <span class="string">"Connection established. Exiting connector thread."</span>);
+<a name="369" href="#369">369</a>           <strong>break</strong>;
+<a name="370" href="#370">370</a>         } <strong>catch</strong> (InterruptedException e) {
+<a name="371" href="#371">371</a>           getLogger().debug(<span class="string">"Connector interrupted. Leaving loop."</span>);
+<a name="372" href="#372">372</a>           <strong>return</strong>;
+<a name="373" href="#373">373</a>         } <strong>catch</strong> (java.net.ConnectException e) {
+<a name="374" href="#374">374</a>           getLogger().debug(<span class="string">"Remote host {} refused connection."</span>, host);
+<a name="375" href="#375">375</a>         } <strong>catch</strong> (IOException e) {
+<a name="376" href="#376">376</a>           getLogger().debug(<span class="string">"Could not connect to {}. Exception is {}."</span>,
+<a name="377" href="#377">377</a>                   host, e);
+<a name="378" href="#378">378</a>         }
+<a name="379" href="#379">379</a>       }
+<a name="380" href="#380">380</a>     }
+<a name="381" href="#381">381</a>   }
+<a name="382" href="#382">382</a> 
+<a name="383" href="#383">383</a>     <em>/**<em>*</em></em>
+<a name="384" href="#384">384</a> <em>     * This method does nothing.</em>
+<a name="385" href="#385">385</a> <em>     * @param remoteInfo remote info.</em>
+<a name="386" href="#386">386</a> <em>     */</em>
+<a name="387" href="#387">387</a>   <strong>public</strong> <strong>void</strong> socketOpened(<strong>final</strong> String remoteInfo) {
+<a name="388" href="#388">388</a> 
+<a name="389" href="#389">389</a>     <em class="comment">// This method does nothing.</em>
+<a name="390" href="#390">390</a>   }
+<a name="391" href="#391">391</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Propchange: logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketHubReceiver.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNode13.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNode13.html?view=auto&rev=558362
==============================================================================
--- logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNode13.html (added)
+++ logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNode13.html Sat Jul 21 10:50:33 2007
@@ -0,0 +1,288 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>SocketNode13 xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/net/SocketNode13.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a>   <em class="comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a>   <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a>   <em class="comment"> * the License.  You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a>   <em class="comment"> *</em>
+<a name="9" href="#9">9</a>   <em class="comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="10" href="#10">10</a>  <em class="comment"> *</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a>  <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a>  <em class="comment"> */</em>
+<a name="17" href="#17">17</a>  
+<a name="18" href="#18">18</a>  <strong>package</strong> org.apache.log4j.net;
+<a name="19" href="#19">19</a>  
+<a name="20" href="#20">20</a>  <strong>import</strong> java.io.BufferedInputStream;
+<a name="21" href="#21">21</a>  <strong>import</strong> java.io.IOException;
+<a name="22" href="#22">22</a>  <strong>import</strong> java.io.ObjectInputStream;
+<a name="23" href="#23">23</a>  <strong>import</strong> java.net.Socket;
+<a name="24" href="#24">24</a>  <strong>import</strong> java.util.ArrayList;
+<a name="25" href="#25">25</a>  <strong>import</strong> java.util.Collections;
+<a name="26" href="#26">26</a>  <strong>import</strong> java.util.Iterator;
+<a name="27" href="#27">27</a>  <strong>import</strong> java.util.List;
+<a name="28" href="#28">28</a>  
+<a name="29" href="#29">29</a>  <strong>import</strong> org.apache.log4j.Logger;
+<a name="30" href="#30">30</a>  <strong>import</strong> org.apache.log4j.plugins.Pauseable;
+<a name="31" href="#31">31</a>  <strong>import</strong> org.apache.log4j.plugins.Receiver;
+<a name="32" href="#32">32</a>  <strong>import</strong> org.apache.log4j.spi.ComponentBase;
+<a name="33" href="#33">33</a>  <strong>import</strong> org.apache.log4j.spi.LoggerRepository;
+<a name="34" href="#34">34</a>  <strong>import</strong> org.apache.log4j.spi.LoggingEvent;
+<a name="35" href="#35">35</a>  
+<a name="36" href="#36">36</a>  
+<a name="37" href="#37">37</a>  <em class="comment">// Contributors:  Moses Hohman &lt;mmhohman@rainbow.uchicago.edu></em>
+<a name="38" href="#38">38</a>  
+<a name="39" href="#39">39</a>  <em>/**<em>*</em></em>
+<a name="40" href="#40">40</a>  <em>   Read {@link LoggingEvent} objects sent from a remote client using</em>
+<a name="41" href="#41">41</a>  <em>   Sockets (TCP). These logging events are logged according to local</em>
+<a name="42" href="#42">42</a>  <em>   policy, as if they were generated locally.</em>
+<a name="43" href="#43">43</a>  
+<a name="44" href="#44">44</a>  <em>   &lt;p>For example, the socket node might decide to log events to a</em>
+<a name="45" href="#45">45</a>  <em>   local file and also resent them to a second socket node.</em>
+<a name="46" href="#46">46</a>  
+<a name="47" href="#47">47</a>  <em>    Implementation lifted from org.apache.log4j.net.SocketNode</em>
+<a name="48" href="#48">48</a>  <em>    in log4j 1.3 and renamed to prevent collision with</em>
+<a name="49" href="#49">49</a>  <em>    log4j 1.2 implementation.</em>
+<a name="50" href="#50">50</a>  
+<a name="51" href="#51">51</a>  <em>    @author  Ceki G&amp;uuml;lc&amp;uuml;</em>
+<a name="52" href="#52">52</a>  <em>    @author  Paul Smith (psmith@apache.org)</em>
+<a name="53" href="#53">53</a>  
+<a name="54" href="#54">54</a>  
+<a name="55" href="#55">55</a>  <em>*/</em>
+<a name="56" href="#56">56</a>  <strong>public</strong> <strong>class</strong> SocketNode13 <strong>extends</strong> ComponentBase implements Runnable, Pauseable {
+<a name="57" href="#57">57</a>  
+<a name="58" href="#58">58</a>      <em>/**<em>*</em></em>
+<a name="59" href="#59">59</a>  <em>     * Paused state.</em>
+<a name="60" href="#60">60</a>  <em>     */</em>
+<a name="61" href="#61">61</a>    <strong>private</strong> <strong>boolean</strong> paused;
+<a name="62" href="#62">62</a>      <em>/**<em>*</em></em>
+<a name="63" href="#63">63</a>  <em>     * Socket.</em>
+<a name="64" href="#64">64</a>  <em>     */</em>
+<a name="65" href="#65">65</a>    <strong>private</strong> Socket socket;
+<a name="66" href="#66">66</a>      <em>/**<em>*</em></em>
+<a name="67" href="#67">67</a>  <em>     * Receiver.</em>
+<a name="68" href="#68">68</a>  <em>     */</em>
+<a name="69" href="#69">69</a>    <strong>private</strong> Receiver receiver;
+<a name="70" href="#70">70</a>      <em>/**<em>*</em></em>
+<a name="71" href="#71">71</a>  <em>     * List of listeners.</em>
+<a name="72" href="#72">72</a>  <em>     */</em>
+<a name="73" href="#73">73</a>    <strong>private</strong> List listenerList = Collections.synchronizedList(<strong>new</strong> ArrayList());
+<a name="74" href="#74">74</a>  
+<a name="75" href="#75">75</a>  
+<a name="76" href="#76">76</a>  
+<a name="77" href="#77">77</a>    <em>/**<em>*</em></em>
+<a name="78" href="#78">78</a>  <em>    Constructor for socket and logger repository.</em>
+<a name="79" href="#79">79</a>  <em>   @param s socket</em>
+<a name="80" href="#80">80</a>  <em>   @param hierarchy logger repository</em>
+<a name="81" href="#81">81</a>  <em>   */</em>
+<a name="82" href="#82">82</a>    <strong>public</strong> SocketNode13(<strong>final</strong> Socket s,
+<a name="83" href="#83">83</a>                      <strong>final</strong> LoggerRepository hierarchy) {
+<a name="84" href="#84">84</a>      <strong>super</strong>();
+<a name="85" href="#85">85</a>      <strong>this</strong>.socket = s;
+<a name="86" href="#86">86</a>      <strong>this</strong>.repository = hierarchy;
+<a name="87" href="#87">87</a>    }
+<a name="88" href="#88">88</a>  
+<a name="89" href="#89">89</a>    <em>/**<em>*</em></em>
+<a name="90" href="#90">90</a>  <em>    Constructor for socket and receiver.</em>
+<a name="91" href="#91">91</a>  <em>   @param s socket</em>
+<a name="92" href="#92">92</a>  <em>   @param r receiver</em>
+<a name="93" href="#93">93</a>  <em>   */</em>
+<a name="94" href="#94">94</a>    <strong>public</strong> SocketNode13(<strong>final</strong> Socket s, <strong>final</strong> Receiver r) {
+<a name="95" href="#95">95</a>      <strong>super</strong>();
+<a name="96" href="#96">96</a>      <strong>this</strong>.socket = s;
+<a name="97" href="#97">97</a>      <strong>this</strong>.receiver = r;
+<a name="98" href="#98">98</a>    }
+<a name="99" href="#99">99</a>  
+<a name="100" href="#100">100</a>   <em>/**<em>*</em></em>
+<a name="101" href="#101">101</a> <em>   * Set the event listener on this node.</em>
+<a name="102" href="#102">102</a> <em>   *</em>
+<a name="103" href="#103">103</a> <em>   * @deprecated Now supports mutliple listeners, this method</em>
+<a name="104" href="#104">104</a> <em>   * simply invokes the removeSocketNodeEventListener() to remove</em>
+<a name="105" href="#105">105</a> <em>   * the listener, and then readds it.</em>
+<a name="106" href="#106">106</a> <em>   * @param l listener</em>
+<a name="107" href="#107">107</a> <em>   */</em>
+<a name="108" href="#108">108</a>   <strong>public</strong> <strong>void</strong> setListener(<strong>final</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> l) {
+<a name="109" href="#109">109</a>     removeSocketNodeEventListener(l);
+<a name="110" href="#110">110</a>     addSocketNodeEventListener(l);
+<a name="111" href="#111">111</a>   }
+<a name="112" href="#112">112</a> 
+<a name="113" href="#113">113</a>   <em>/**<em>*</em></em>
+<a name="114" href="#114">114</a> <em>   * Adds the listener to the list of listeners to be notified of the</em>
+<a name="115" href="#115">115</a> <em>   * respective event.</em>
+<a name="116" href="#116">116</a> <em>   * @param listener the listener to add to the list</em>
+<a name="117" href="#117">117</a> <em>   */</em>
+<a name="118" href="#118">118</a>   <strong>public</strong> <strong>void</strong> addSocketNodeEventListener(
+<a name="119" href="#119">119</a>           <strong>final</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> listener) {
+<a name="120" href="#120">120</a>     listenerList.add(listener);
+<a name="121" href="#121">121</a>   }
+<a name="122" href="#122">122</a> 
+<a name="123" href="#123">123</a>   <em>/**<em>*</em></em>
+<a name="124" href="#124">124</a> <em>   * Removes the registered Listener from this instances list of</em>
+<a name="125" href="#125">125</a> <em>   * listeners.  If the listener has not been registered, then invoking</em>
+<a name="126" href="#126">126</a> <em>   * this method has no effect.</em>
+<a name="127" href="#127">127</a> <em>   *</em>
+<a name="128" href="#128">128</a> <em>   * @param listener the SocketNodeEventListener to remove</em>
+<a name="129" href="#129">129</a> <em>   */</em>
+<a name="130" href="#130">130</a>   <strong>public</strong> <strong>void</strong> removeSocketNodeEventListener(
+<a name="131" href="#131">131</a>           <strong>final</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> listener) {
+<a name="132" href="#132">132</a>     listenerList.remove(listener);
+<a name="133" href="#133">133</a>   }
+<a name="134" href="#134">134</a> 
+<a name="135" href="#135">135</a> 
+<a name="136" href="#136">136</a>     <em>/**<em>*</em></em>
+<a name="137" href="#137">137</a> <em>     * Deserialize events from socket until interrupted.</em>
+<a name="138" href="#138">138</a> <em>     */</em>
+<a name="139" href="#139">139</a>   <strong>public</strong> <strong>void</strong> run() {
+<a name="140" href="#140">140</a>     LoggingEvent event;
+<a name="141" href="#141">141</a>     Logger remoteLogger;
+<a name="142" href="#142">142</a>     Exception listenerException = <strong>null</strong>;
+<a name="143" href="#143">143</a>     ObjectInputStream ois = <strong>null</strong>;
+<a name="144" href="#144">144</a> 
+<a name="145" href="#145">145</a>     <strong>try</strong> {
+<a name="146" href="#146">146</a>       ois =
+<a name="147" href="#147">147</a>         <strong>new</strong> ObjectInputStream(
+<a name="148" href="#148">148</a>           <strong>new</strong> BufferedInputStream(socket.getInputStream()));
+<a name="149" href="#149">149</a>     } <strong>catch</strong> (Exception e) {
+<a name="150" href="#150">150</a>       ois = <strong>null</strong>;
+<a name="151" href="#151">151</a>       listenerException = e;
+<a name="152" href="#152">152</a>       getLogger().error(<span class="string">"Exception opening ObjectInputStream to "</span> + socket, e);
+<a name="153" href="#153">153</a>     }
+<a name="154" href="#154">154</a> 
+<a name="155" href="#155">155</a>     <strong>if</strong> (ois != <strong>null</strong>) {
+<a name="156" href="#156">156</a>       String remoteInfo =
+<a name="157" href="#157">157</a>         socket.getInetAddress().getHostName() + <span class="string">":"</span> + socket.getPort();
+<a name="158" href="#158">158</a> 
+<a name="159" href="#159">159</a>       <em>/**<em>*</em></em>
+<a name="160" href="#160">160</a> <em>       * notify the listener that the socket has been</em>
+<a name="161" href="#161">161</a> <em>       * opened and this SocketNode is ready and waiting</em>
+<a name="162" href="#162">162</a> <em>       */</em>
+<a name="163" href="#163">163</a>       fireSocketOpened(remoteInfo);
+<a name="164" href="#164">164</a> 
+<a name="165" href="#165">165</a>       <strong>try</strong> {
+<a name="166" href="#166">166</a>         <strong>while</strong> (<strong>true</strong>) {
+<a name="167" href="#167">167</a>           <em class="comment">// read an event from the wire</em>
+<a name="168" href="#168">168</a>           event = (LoggingEvent) ois.readObject();
+<a name="169" href="#169">169</a> 
+<a name="170" href="#170">170</a>           <em class="comment">// store the known remote info in an event property</em>
+<a name="171" href="#171">171</a>           event.setProperty(<span class="string">"log4j.remoteSourceInfo"</span>, remoteInfo);
+<a name="172" href="#172">172</a> 
+<a name="173" href="#173">173</a>           <em class="comment">// if configured with a receiver, tell it to post the event</em>
+<a name="174" href="#174">174</a>           <strong>if</strong> (!isPaused()) {
+<a name="175" href="#175">175</a>             <strong>if</strong> ((receiver != <strong>null</strong>)) {
+<a name="176" href="#176">176</a>               receiver.doPost(event);
+<a name="177" href="#177">177</a> 
+<a name="178" href="#178">178</a>               <em class="comment">// else post it via the hierarchy</em>
+<a name="179" href="#179">179</a>             } <strong>else</strong> {
+<a name="180" href="#180">180</a>               <em class="comment">// get a logger from the hierarchy. The name of the logger</em>
+<a name="181" href="#181">181</a>               <em class="comment">// is taken to be the name contained in the event.</em>
+<a name="182" href="#182">182</a>               remoteLogger = repository.getLogger(event.getLoggerName());
+<a name="183" href="#183">183</a> 
+<a name="184" href="#184">184</a>               <em class="comment">//event.logger = remoteLogger;</em>
+<a name="185" href="#185">185</a>               <em class="comment">// apply the logger-level filter</em>
+<a name="186" href="#186">186</a>               <strong>if</strong> (event
+<a name="187" href="#187">187</a>                 .getLevel()
+<a name="188" href="#188">188</a>                 .isGreaterOrEqual(remoteLogger.getEffectiveLevel())) {
+<a name="189" href="#189">189</a>                 <em class="comment">// finally log the event as if was generated locally</em>
+<a name="190" href="#190">190</a>                 remoteLogger.callAppenders(event);
+<a name="191" href="#191">191</a>               }
+<a name="192" href="#192">192</a>             }
+<a name="193" href="#193">193</a>           } <strong>else</strong> {
+<a name="194" href="#194">194</a>             <em class="comment">//we simply discard this event.</em>
+<a name="195" href="#195">195</a>           }
+<a name="196" href="#196">196</a>         }
+<a name="197" href="#197">197</a>       } <strong>catch</strong> (java.io.EOFException e) {
+<a name="198" href="#198">198</a>         getLogger().info(<span class="string">"Caught java.io.EOFException closing connection."</span>);
+<a name="199" href="#199">199</a>         listenerException = e;
+<a name="200" href="#200">200</a>       } <strong>catch</strong> (java.net.SocketException e) {
+<a name="201" href="#201">201</a>         getLogger().info(<span class="string">"Caught java.net.SocketException closing connection."</span>);
+<a name="202" href="#202">202</a>         listenerException = e;
+<a name="203" href="#203">203</a>       } <strong>catch</strong> (IOException e) {
+<a name="204" href="#204">204</a>         getLogger().info(<span class="string">"Caught java.io.IOException: "</span> + e);
+<a name="205" href="#205">205</a>         getLogger().info(<span class="string">"Closing connection."</span>);
+<a name="206" href="#206">206</a>         listenerException = e;
+<a name="207" href="#207">207</a>       } <strong>catch</strong> (Exception e) {
+<a name="208" href="#208">208</a>         getLogger().error(<span class="string">"Unexpected exception. Closing connection."</span>, e);
+<a name="209" href="#209">209</a>         listenerException = e;
+<a name="210" href="#210">210</a>       }
+<a name="211" href="#211">211</a>     }
+<a name="212" href="#212">212</a> 
+<a name="213" href="#213">213</a>     <em class="comment">// close the socket</em>
+<a name="214" href="#214">214</a>     <strong>try</strong> {
+<a name="215" href="#215">215</a>       <strong>if</strong> (ois != <strong>null</strong>) {
+<a name="216" href="#216">216</a>         ois.close();
+<a name="217" href="#217">217</a>       }
+<a name="218" href="#218">218</a>     } <strong>catch</strong> (Exception e) {
+<a name="219" href="#219">219</a>       <em class="comment">//getLogger().info("Could not close connection.", e);</em>
+<a name="220" href="#220">220</a>     }
+<a name="221" href="#221">221</a> 
+<a name="222" href="#222">222</a>     <em class="comment">// send event to listener, if configured</em>
+<a name="223" href="#223">223</a>     <strong>if</strong> (listenerList.size() > 0) {
+<a name="224" href="#224">224</a>       fireSocketClosedEvent(listenerException);
+<a name="225" href="#225">225</a>     }
+<a name="226" href="#226">226</a>   }
+<a name="227" href="#227">227</a> 
+<a name="228" href="#228">228</a>   <em>/**<em>*</em></em>
+<a name="229" href="#229">229</a> <em>   * Notifies all registered listeners regarding the closing of the Socket.</em>
+<a name="230" href="#230">230</a> <em>   * @param listenerException listener exception</em>
+<a name="231" href="#231">231</a> <em>   */</em>
+<a name="232" href="#232">232</a>   <strong>private</strong> <strong>void</strong> fireSocketClosedEvent(<strong>final</strong> Exception listenerException) {
+<a name="233" href="#233">233</a>     <strong>synchronized</strong> (listenerList) {
+<a name="234" href="#234">234</a>         <strong>for</strong> (Iterator iter = listenerList.iterator(); iter.hasNext();) {
+<a name="235" href="#235">235</a>             <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> snel =
+<a name="236" href="#236">236</a>                     (<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a>) iter.next();
+<a name="237" href="#237">237</a>             <strong>if</strong> (snel != <strong>null</strong>) {
+<a name="238" href="#238">238</a>                 snel.socketClosedEvent(listenerException);
+<a name="239" href="#239">239</a>             }
+<a name="240" href="#240">240</a>         }
+<a name="241" href="#241">241</a>     }
+<a name="242" href="#242">242</a>   }
+<a name="243" href="#243">243</a> 
+<a name="244" href="#244">244</a>   <em>/**<em>*</em></em>
+<a name="245" href="#245">245</a> <em>   * Notifies all registered listeners regarding the opening of a Socket.</em>
+<a name="246" href="#246">246</a> <em>   * @param remoteInfo remote info</em>
+<a name="247" href="#247">247</a> <em>   */</em>
+<a name="248" href="#248">248</a>   <strong>private</strong> <strong>void</strong> fireSocketOpened(<strong>final</strong> String remoteInfo) {
+<a name="249" href="#249">249</a>     <strong>synchronized</strong> (listenerList) {
+<a name="250" href="#250">250</a>         <strong>for</strong> (Iterator iter = listenerList.iterator(); iter.hasNext();) {
+<a name="251" href="#251">251</a>             <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> snel =
+<a name="252" href="#252">252</a>                     (<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a>) iter.next();
+<a name="253" href="#253">253</a>             <strong>if</strong> (snel != <strong>null</strong>) {
+<a name="254" href="#254">254</a>                 snel.socketOpened(remoteInfo);
+<a name="255" href="#255">255</a>             }
+<a name="256" href="#256">256</a>         }
+<a name="257" href="#257">257</a>     }
+<a name="258" href="#258">258</a>   }
+<a name="259" href="#259">259</a> 
+<a name="260" href="#260">260</a>     <em>/**<em>*</em></em>
+<a name="261" href="#261">261</a> <em>     * Sets if node is paused.</em>
+<a name="262" href="#262">262</a> <em>     * @param b new value</em>
+<a name="263" href="#263">263</a> <em>     */</em>
+<a name="264" href="#264">264</a>   <strong>public</strong> <strong>void</strong> setPaused(<strong>final</strong> <strong>boolean</strong> b) {
+<a name="265" href="#265">265</a>     <strong>this</strong>.paused = b;
+<a name="266" href="#266">266</a>   }
+<a name="267" href="#267">267</a> 
+<a name="268" href="#268">268</a>     <em>/**<em>*</em></em>
+<a name="269" href="#269">269</a> <em>     * Get if node is paused.</em>
+<a name="270" href="#270">270</a> <em>     * @return true if pause.</em>
+<a name="271" href="#271">271</a> <em>     */</em>
+<a name="272" href="#272">272</a>   <strong>public</strong> <strong>boolean</strong> isPaused() {
+<a name="273" href="#273">273</a>     <strong>return</strong> <strong>this</strong>.paused;
+<a name="274" href="#274">274</a>   }
+<a name="275" href="#275">275</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Propchange: logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNode13.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNodeEventListener.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNodeEventListener.html?view=auto&rev=558362
==============================================================================
--- logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNodeEventListener.html (added)
+++ logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNodeEventListener.html Sat Jul 21 10:50:33 2007
@@ -0,0 +1,57 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>SocketNodeEventListener xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/net/SocketNodeEventListener.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a>   <em class="comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a>   <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a>   <em class="comment"> * the License.  You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a>   <em class="comment"> *</em>
+<a name="9" href="#9">9</a>   <em class="comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="10" href="#10">10</a>  <em class="comment"> *</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a>  <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a>  <em class="comment"> */</em>
+<a name="17" href="#17">17</a>  
+<a name="18" href="#18">18</a>  <strong>package</strong> org.apache.log4j.net;
+<a name="19" href="#19">19</a>  
+<a name="20" href="#20">20</a>  <strong>import</strong> java.util.EventListener;
+<a name="21" href="#21">21</a>  
+<a name="22" href="#22">22</a>  <em>/**<em>*</em></em>
+<a name="23" href="#23">23</a>  <em>  Interface used to listen for {@link SocketNode} related</em>
+<a name="24" href="#24">24</a>  <em>  events. Clients register an instance of the interface and the</em>
+<a name="25" href="#25">25</a>  <em>  instance is called back when the various events occur.</em>
+<a name="26" href="#26">26</a>  
+<a name="27" href="#27">27</a>  <em>  @author Mark Womack</em>
+<a name="28" href="#28">28</a>  <em>  @author Paul Smith (psmith@apache.org)</em>
+<a name="29" href="#29">29</a>  <em>  @since 1.3</em>
+<a name="30" href="#30">30</a>  <em>*/</em>
+<a name="31" href="#31">31</a>  <strong>public</strong> <strong>interface</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> <strong>extends</strong> EventListener {
+<a name="32" href="#32">32</a>  
+<a name="33" href="#33">33</a>    <em>/**<em>*</em></em>
+<a name="34" href="#34">34</a>  <em>   * Called when the SocketNode is created and begins awaiting data.</em>
+<a name="35" href="#35">35</a>  <em>   *  @param remoteInfo remote info</em>
+<a name="36" href="#36">36</a>  <em>   */</em>
+<a name="37" href="#37">37</a>    <strong>void</strong> socketOpened(String remoteInfo);
+<a name="38" href="#38">38</a>  
+<a name="39" href="#39">39</a>    <em>/**<em>*</em></em>
+<a name="40" href="#40">40</a>  <em>    Called when the socket the node was given has been closed.</em>
+<a name="41" href="#41">41</a>  <em>    @param e exception</em>
+<a name="42" href="#42">42</a>  <em>   */</em>
+<a name="43" href="#43">43</a>    <strong>void</strong> socketClosedEvent(Exception e);
+<a name="44" href="#44">44</a>  }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Propchange: logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNodeEventListener.html
------------------------------------------------------------------------------
    svn:mime-type = text/html



Mime
View raw message