You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@logging.apache.org by ca...@apache.org on 2007/08/29 21:46:35 UTC

svn commit: r570911 [12/21] - in /logging/site/trunk/docs/log4j/companions/receivers: ./ apidocs/ apidocs/org/apache/log4j/db/ apidocs/org/apache/log4j/db/class-use/ apidocs/org/apache/log4j/db/dialect/ apidocs/org/apache/log4j/db/dialect/class-use/ ap...

Modified: logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/MulticastAppender.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/MulticastAppender.html?rev=570911&r1=570910&r2=570911&view=diff
==============================================================================
--- logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/MulticastAppender.html (original)
+++ logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/MulticastAppender.html Wed Aug 29 12:46:25 2007
@@ -71,252 +71,255 @@
 <a name="62" href="#62">62</a>    String hostname;
 <a name="63" href="#63">63</a>    String remoteHost;
 <a name="64" href="#64">64</a>    String application;
-<a name="65" href="#65">65</a>    String overrideProperties = <span class="string">"true"</span>;
-<a name="66" href="#66">66</a>    <strong>int</strong> timeToLive;
-<a name="67" href="#67">67</a>    InetAddress address;
-<a name="68" href="#68">68</a>    <strong>int</strong> port = DEFAULT_PORT;
-<a name="69" href="#69">69</a>    MulticastSocket outSocket;
-<a name="70" href="#70">70</a>    <strong>private</strong> String encoding;
-<a name="71" href="#71">71</a>    
-<a name="72" href="#72">72</a>    <strong>public</strong> <a href="../../../../org/apache/log4j/net/MulticastAppender.html">MulticastAppender</a>() {
-<a name="73" href="#73">73</a>       <strong>super</strong>(false);
-<a name="74" href="#74">74</a>    }
-<a name="75" href="#75">75</a>  
-<a name="76" href="#76">76</a>    <em>/**<em>*</em></em>
-<a name="77" href="#77">77</a>  <em>     Open the multicast sender for the &lt;b>RemoteHost&lt;/b> and &lt;b>Port&lt;/b>.</em>
-<a name="78" href="#78">78</a>  <em>  */</em>
-<a name="79" href="#79">79</a>    <strong>public</strong> <strong>void</strong> activateOptions() {
-<a name="80" href="#80">80</a>      <strong>try</strong> {
-<a name="81" href="#81">81</a>        hostname = InetAddress.getLocalHost().getHostName();
-<a name="82" href="#82">82</a>      } <strong>catch</strong> (UnknownHostException uhe) {
-<a name="83" href="#83">83</a>        <strong>try</strong> {
-<a name="84" href="#84">84</a>          hostname = InetAddress.getLocalHost().getHostAddress();
-<a name="85" href="#85">85</a>        } <strong>catch</strong> (UnknownHostException uhe2) {
-<a name="86" href="#86">86</a>          hostname = <span class="string">"unknown"</span>;
-<a name="87" href="#87">87</a>        }
-<a name="88" href="#88">88</a>      }
-<a name="89" href="#89">89</a>  
-<a name="90" href="#90">90</a>      <em class="comment">//allow system property of application to be primary</em>
-<a name="91" href="#91">91</a>      <strong>if</strong> (application == <strong>null</strong>) {
-<a name="92" href="#92">92</a>        application = System.getProperty(Constants.APPLICATION_KEY);
-<a name="93" href="#93">93</a>      } <strong>else</strong> {
-<a name="94" href="#94">94</a>        <strong>if</strong> (System.getProperty(Constants.APPLICATION_KEY) != <strong>null</strong>) {
-<a name="95" href="#95">95</a>          application = application + <span class="string">"-"</span> + System.getProperty(Constants.APPLICATION_KEY);
-<a name="96" href="#96">96</a>        }
-<a name="97" href="#97">97</a>      }
-<a name="98" href="#98">98</a>  
-<a name="99" href="#99">99</a>      <strong>if</strong>(remoteHost != <strong>null</strong>) {
-<a name="100" href="#100">100</a>       address = getAddressByName(remoteHost);
-<a name="101" href="#101">101</a>     } <strong>else</strong> {
-<a name="102" href="#102">102</a>       String err = <span class="string">"The RemoteHost property is required for SocketAppender named "</span>+ name;
-<a name="103" href="#103">103</a>       LogLog.error(err);
-<a name="104" href="#104">104</a>       <strong>throw</strong> <strong>new</strong> IllegalStateException(err);
-<a name="105" href="#105">105</a>     }
-<a name="106" href="#106">106</a>     
-<a name="107" href="#107">107</a>     connect();
-<a name="108" href="#108">108</a>     <strong>super</strong>.activateOptions();
-<a name="109" href="#109">109</a>   }
-<a name="110" href="#110">110</a> 
-<a name="111" href="#111">111</a>   <em>/**<em>*</em></em>
-<a name="112" href="#112">112</a> <em>     Close this appender.</em>
-<a name="113" href="#113">113</a> <em>     &lt;p>This will mark the appender as closed and</em>
-<a name="114" href="#114">114</a> <em>     call then {@link #cleanUp} method.</em>
-<a name="115" href="#115">115</a> <em>  */</em>
-<a name="116" href="#116">116</a>   <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> close() {
-<a name="117" href="#117">117</a>     <strong>if</strong> (closed) {
-<a name="118" href="#118">118</a>       <strong>return</strong>;
-<a name="119" href="#119">119</a>     }
-<a name="120" href="#120">120</a> 
-<a name="121" href="#121">121</a>     <strong>this</strong>.closed = <strong>true</strong>;
-<a name="122" href="#122">122</a>     cleanUp();
-<a name="123" href="#123">123</a>   }
-<a name="124" href="#124">124</a> 
-<a name="125" href="#125">125</a>   <em>/**<em>*</em></em>
-<a name="126" href="#126">126</a> <em>     Close the Socket and release the underlying</em>
-<a name="127" href="#127">127</a> <em>     connector thread if it has been created</em>
-<a name="128" href="#128">128</a> <em>   */</em>
-<a name="129" href="#129">129</a>   <strong>public</strong> <strong>void</strong> cleanUp() {
-<a name="130" href="#130">130</a>     <strong>if</strong> (outSocket != <strong>null</strong>) {
-<a name="131" href="#131">131</a>       <strong>try</strong> {
-<a name="132" href="#132">132</a>         outSocket.close();
-<a name="133" href="#133">133</a>       } <strong>catch</strong> (Exception e) {
-<a name="134" href="#134">134</a>         LogLog.error(<span class="string">"Could not close outSocket."</span>, e);
-<a name="135" href="#135">135</a>       }
-<a name="136" href="#136">136</a> 
-<a name="137" href="#137">137</a>       outSocket = <strong>null</strong>;
-<a name="138" href="#138">138</a>     }
-<a name="139" href="#139">139</a>   }
-<a name="140" href="#140">140</a> 
-<a name="141" href="#141">141</a>   <strong>void</strong> connect() {
-<a name="142" href="#142">142</a>     <strong>if</strong> (<strong>this</strong>.address == <strong>null</strong>) {
-<a name="143" href="#143">143</a>       <strong>return</strong>;
-<a name="144" href="#144">144</a>     }
-<a name="145" href="#145">145</a> 
-<a name="146" href="#146">146</a>     <strong>try</strong> {
-<a name="147" href="#147">147</a>       <em class="comment">// First, close the previous connection if any.</em>
-<a name="148" href="#148">148</a>       cleanUp();
-<a name="149" href="#149">149</a>       outSocket = <strong>new</strong> MulticastSocket();
-<a name="150" href="#150">150</a>       outSocket.setTimeToLive(timeToLive);
-<a name="151" href="#151">151</a>     } <strong>catch</strong> (IOException e) {
-<a name="152" href="#152">152</a>       LogLog.error(<span class="string">"Error in connect method of MulticastAppender named "</span>+name, e);
-<a name="153" href="#153">153</a>     }
-<a name="154" href="#154">154</a>   }
-<a name="155" href="#155">155</a> 
-<a name="156" href="#156">156</a>   <strong>public</strong> <strong>void</strong> append(LoggingEvent event) {
-<a name="157" href="#157">157</a>     <strong>if</strong> (event == <strong>null</strong>) {
-<a name="158" href="#158">158</a>       <strong>return</strong>;
-<a name="159" href="#159">159</a>     }
-<a name="160" href="#160">160</a> 
-<a name="161" href="#161">161</a>     <strong>if</strong> (outSocket != <strong>null</strong>) {
-<a name="162" href="#162">162</a>       <em class="comment">//if the values already exist, don't set (useful when forwarding from a simplesocketserver</em>
-<a name="163" href="#163">163</a>       <strong>if</strong> (
-<a name="164" href="#164">164</a>         (overrideProperties != <strong>null</strong>)
-<a name="165" href="#165">165</a>           &amp;&amp; overrideProperties.equalsIgnoreCase(<span class="string">"true"</span>)) {
-<a name="166" href="#166">166</a>         event.setProperty(Constants.HOSTNAME_KEY, hostname);
-<a name="167" href="#167">167</a> 
-<a name="168" href="#168">168</a>         <strong>if</strong> (application != <strong>null</strong>) {
-<a name="169" href="#169">169</a>           event.setProperty(Constants.APPLICATION_KEY, application);
-<a name="170" href="#170">170</a>         }
-<a name="171" href="#171">171</a>       }
-<a name="172" href="#172">172</a> 
-<a name="173" href="#173">173</a>       <strong>try</strong> {
-<a name="174" href="#174">174</a>         StringBuffer buf = <strong>new</strong> StringBuffer(layout.format(event));
-<a name="175" href="#175">175</a> 
-<a name="176" href="#176">176</a>         byte[] payload;
-<a name="177" href="#177">177</a>         <strong>if</strong>(encoding == <strong>null</strong>) {
-<a name="178" href="#178">178</a>           payload = buf.toString().getBytes();
-<a name="179" href="#179">179</a>         } <strong>else</strong> {
-<a name="180" href="#180">180</a>           payload = buf.toString().getBytes(encoding);
-<a name="181" href="#181">181</a>         }
-<a name="182" href="#182">182</a> 
-<a name="183" href="#183">183</a>         DatagramPacket dp =
-<a name="184" href="#184">184</a>            <strong>new</strong> DatagramPacket(payload, payload.length, address, port);
-<a name="185" href="#185">185</a>         outSocket.send(dp);
-<a name="186" href="#186">186</a>         <em class="comment">//remove these properties, in case other appenders need to set them to different values </em>
-<a name="187" href="#187">187</a>         event.setProperty(Constants.HOSTNAME_KEY, <strong>null</strong>);
-<a name="188" href="#188">188</a>         event.setProperty(Constants.APPLICATION_KEY, <strong>null</strong>);
-<a name="189" href="#189">189</a>       } <strong>catch</strong> (IOException e) {
-<a name="190" href="#190">190</a>         outSocket = <strong>null</strong>;
-<a name="191" href="#191">191</a>         LogLog.warn(<span class="string">"Detected problem with Multicast connection: "</span> + e);
-<a name="192" href="#192">192</a>       }
-<a name="193" href="#193">193</a>     }
-<a name="194" href="#194">194</a>   }
-<a name="195" href="#195">195</a> 
-<a name="196" href="#196">196</a>   InetAddress getAddressByName(String host) {
-<a name="197" href="#197">197</a>     <strong>try</strong> {
-<a name="198" href="#198">198</a>       <strong>return</strong> InetAddress.getByName(host);
-<a name="199" href="#199">199</a>     } <strong>catch</strong> (Exception e) {
-<a name="200" href="#200">200</a>       LogLog.error(<span class="string">"Could not find address of ["</span> + host + <span class="string">"]."</span>, e);
-<a name="201" href="#201">201</a>       <strong>return</strong> <strong>null</strong>;
-<a name="202" href="#202">202</a>     }
-<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>     The &lt;b>RemoteHost&lt;/b> option takes a string value which should be</em>
-<a name="207" href="#207">207</a> <em>     the host name or ipaddress to send the multicast packets.</em>
-<a name="208" href="#208">208</a> <em>   */</em>
-<a name="209" href="#209">209</a>   <strong>public</strong> <strong>void</strong> setRemoteHost(String host) {
-<a name="210" href="#210">210</a>     remoteHost = host;
-<a name="211" href="#211">211</a>   }
-<a name="212" href="#212">212</a> 
-<a name="213" href="#213">213</a>   <em>/**<em>*</em></em>
-<a name="214" href="#214">214</a> <em>     Returns value of the &lt;b>RemoteHost&lt;/b> option.</em>
-<a name="215" href="#215">215</a> <em>   */</em>
-<a name="216" href="#216">216</a>   <strong>public</strong> String getRemoteHost() {
-<a name="217" href="#217">217</a>     <strong>return</strong> remoteHost;
-<a name="218" href="#218">218</a>   }
-<a name="219" href="#219">219</a> 
-<a name="220" href="#220">220</a>   <em>/**<em>*</em></em>
-<a name="221" href="#221">221</a> <em>      The &lt;b>Encoding&lt;/b> option specifies how the bytes are encoded.  If this option is not specified, </em>
-<a name="222" href="#222">222</a> <em>      the System encoding is used.</em>
-<a name="223" href="#223">223</a> <em>    */</em>
-<a name="224" href="#224">224</a>    <strong>public</strong> <strong>void</strong> setEncoding(String encoding) {
-<a name="225" href="#225">225</a>      <strong>this</strong>.encoding = encoding;
-<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>      Returns value of the &lt;b>Encoding&lt;/b> option.</em>
-<a name="230" href="#230">230</a> <em>    */</em>
-<a name="231" href="#231">231</a>    <strong>public</strong> String getEncoding() {
-<a name="232" href="#232">232</a>      <strong>return</strong> encoding;
-<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>     The &lt;b>App&lt;/b> option takes a string value which should be the name of the application getting logged.</em>
-<a name="236" href="#236">236</a> <em>     If property was already set (via system property), don't set here.</em>
-<a name="237" href="#237">237</a> <em>   */</em>
-<a name="238" href="#238">238</a>   <strong>public</strong> <strong>void</strong> setApplication(String app) {
-<a name="239" href="#239">239</a>     <strong>this</strong>.application = app;
-<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>     Returns value of the &lt;b>App&lt;/b> option.</em>
-<a name="244" href="#244">244</a> <em>   */</em>
-<a name="245" href="#245">245</a>   <strong>public</strong> String getApplication() {
-<a name="246" href="#246">246</a>     <strong>return</strong> application;
-<a name="247" href="#247">247</a>   }
-<a name="248" href="#248">248</a> 
-<a name="249" href="#249">249</a>   <em>/**<em>*</em></em>
-<a name="250" href="#250">250</a> <em>     The &lt;b>OverrideProperties&lt;/b> option allows configurations where the appender does not apply</em>
-<a name="251" href="#251">251</a> <em>     the machinename/appname properties - the properties will be used as provided.</em>
-<a name="252" href="#252">252</a> <em>   */</em>
-<a name="253" href="#253">253</a>   <strong>public</strong> <strong>void</strong> setOverrideProperties(String overrideProperties) {
-<a name="254" href="#254">254</a>     <strong>this</strong>.overrideProperties = overrideProperties;
-<a name="255" href="#255">255</a>   }
-<a name="256" href="#256">256</a> 
-<a name="257" href="#257">257</a>   <em>/**<em>*</em></em>
-<a name="258" href="#258">258</a> <em>     Returns value of the &lt;b>OverrideProperties&lt;/b> option.</em>
-<a name="259" href="#259">259</a> <em>   */</em>
-<a name="260" href="#260">260</a>   <strong>public</strong> String getOverrideProperties() {
-<a name="261" href="#261">261</a>     <strong>return</strong> overrideProperties;
-<a name="262" href="#262">262</a>   }
-<a name="263" href="#263">263</a> 
-<a name="264" href="#264">264</a>   <em>/**<em>*</em></em>
-<a name="265" href="#265">265</a> <em>     The &lt;b>Time to live&lt;/b> option takes a positive integer representing</em>
-<a name="266" href="#266">266</a> <em>     the time to live value.</em>
-<a name="267" href="#267">267</a> <em>   */</em>
-<a name="268" href="#268">268</a>   <strong>public</strong> <strong>void</strong> setTimeToLive(<strong>int</strong> timeToLive) {
-<a name="269" href="#269">269</a>     <strong>this</strong>.timeToLive = timeToLive;
-<a name="270" href="#270">270</a>   }
-<a name="271" href="#271">271</a> 
-<a name="272" href="#272">272</a>   <em>/**<em>*</em></em>
-<a name="273" href="#273">273</a> <em>     Returns value of the &lt;b>Time to Live&lt;/b> option.</em>
-<a name="274" href="#274">274</a> <em>   */</em>
-<a name="275" href="#275">275</a>   <strong>public</strong> <strong>int</strong> getTimeToLive() {
-<a name="276" href="#276">276</a>     <strong>return</strong> timeToLive;
-<a name="277" href="#277">277</a>   }
-<a name="278" href="#278">278</a> 
-<a name="279" href="#279">279</a>   <em>/**<em>*</em></em>
-<a name="280" href="#280">280</a> <em>     The &lt;b>Port&lt;/b> option takes a positive integer representing</em>
-<a name="281" href="#281">281</a> <em>     the port where multicast packets will be sent.</em>
-<a name="282" href="#282">282</a> <em>   */</em>
-<a name="283" href="#283">283</a>   <strong>public</strong> <strong>void</strong> setPort(<strong>int</strong> port) {
-<a name="284" href="#284">284</a>     <strong>this</strong>.port = port;
-<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>     Returns value of the &lt;b>Port&lt;/b> option.</em>
-<a name="289" href="#289">289</a> <em>   */</em>
-<a name="290" href="#290">290</a>   <strong>public</strong> <strong>int</strong> getPort() {
-<a name="291" href="#291">291</a>     <strong>return</strong> port;
-<a name="292" href="#292">292</a>   }
-<a name="293" href="#293">293</a> 
-<a name="294" href="#294">294</a>   <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
-<a name="295" href="#295">295</a> <em class="comment">   * @see org.apache.log4j.net.NetworkBased#isActive()</em>
-<a name="296" href="#296">296</a> <em class="comment">   */</em>
-<a name="297" href="#297">297</a>   <strong>public</strong> <strong>boolean</strong> isActive() {
-<a name="298" href="#298">298</a>     <em class="comment">// TODO handle active/inactive</em>
-<a name="299" href="#299">299</a>     <strong>return</strong> <strong>true</strong>;
-<a name="300" href="#300">300</a>   }
-<a name="301" href="#301">301</a> 
-<a name="302" href="#302">302</a>     <em>/**<em>*</em></em>
-<a name="303" href="#303">303</a> <em>     * Gets whether appender requires a layout.</em>
-<a name="304" href="#304">304</a> <em>     * @return false</em>
-<a name="305" href="#305">305</a> <em>     */</em>
-<a name="306" href="#306">306</a>   <strong>public</strong> <strong>boolean</strong> requiresLayout() {
-<a name="307" href="#307">307</a>       <strong>return</strong> <strong>true</strong>;
-<a name="308" href="#308">308</a>   }
-<a name="309" href="#309">309</a> 
-<a name="310" href="#310">310</a> }
+<a name="65" href="#65">65</a>    <strong>int</strong> timeToLive;
+<a name="66" href="#66">66</a>    InetAddress address;
+<a name="67" href="#67">67</a>    <strong>int</strong> port = DEFAULT_PORT;
+<a name="68" href="#68">68</a>    MulticastSocket outSocket;
+<a name="69" href="#69">69</a>    <strong>private</strong> String encoding;
+<a name="70" href="#70">70</a>  
+<a name="71" href="#71">71</a>    <strong>private</strong> <strong>boolean</strong> locationInfo = false;
+<a name="72" href="#72">72</a>    
+<a name="73" href="#73">73</a>    <strong>public</strong> <a href="../../../../org/apache/log4j/net/MulticastAppender.html">MulticastAppender</a>() {
+<a name="74" href="#74">74</a>       <strong>super</strong>(false);
+<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>     Open the multicast sender for the &lt;b>RemoteHost&lt;/b> and &lt;b>Port&lt;/b>.</em>
+<a name="79" href="#79">79</a>  <em>  */</em>
+<a name="80" href="#80">80</a>    <strong>public</strong> <strong>void</strong> activateOptions() {
+<a name="81" href="#81">81</a>      <strong>try</strong> {
+<a name="82" href="#82">82</a>        hostname = InetAddress.getLocalHost().getHostName();
+<a name="83" href="#83">83</a>      } <strong>catch</strong> (UnknownHostException uhe) {
+<a name="84" href="#84">84</a>        <strong>try</strong> {
+<a name="85" href="#85">85</a>          hostname = InetAddress.getLocalHost().getHostAddress();
+<a name="86" href="#86">86</a>        } <strong>catch</strong> (UnknownHostException uhe2) {
+<a name="87" href="#87">87</a>          hostname = <span class="string">"unknown"</span>;
+<a name="88" href="#88">88</a>        }
+<a name="89" href="#89">89</a>      }
+<a name="90" href="#90">90</a>  
+<a name="91" href="#91">91</a>      <em class="comment">//allow system property of application to be primary</em>
+<a name="92" href="#92">92</a>      <strong>if</strong> (application == <strong>null</strong>) {
+<a name="93" href="#93">93</a>        application = System.getProperty(Constants.APPLICATION_KEY);
+<a name="94" href="#94">94</a>      } <strong>else</strong> {
+<a name="95" href="#95">95</a>        <strong>if</strong> (System.getProperty(Constants.APPLICATION_KEY) != <strong>null</strong>) {
+<a name="96" href="#96">96</a>          application = application + <span class="string">"-"</span> + System.getProperty(Constants.APPLICATION_KEY);
+<a name="97" href="#97">97</a>        }
+<a name="98" href="#98">98</a>      }
+<a name="99" href="#99">99</a>  
+<a name="100" href="#100">100</a>     <strong>if</strong>(remoteHost != <strong>null</strong>) {
+<a name="101" href="#101">101</a>       address = getAddressByName(remoteHost);
+<a name="102" href="#102">102</a>     } <strong>else</strong> {
+<a name="103" href="#103">103</a>       String err = <span class="string">"The RemoteHost property is required for SocketAppender named "</span>+ name;
+<a name="104" href="#104">104</a>       LogLog.error(err);
+<a name="105" href="#105">105</a>       <strong>throw</strong> <strong>new</strong> IllegalStateException(err);
+<a name="106" href="#106">106</a>     }
+<a name="107" href="#107">107</a>     
+<a name="108" href="#108">108</a>     connect();
+<a name="109" href="#109">109</a>     <strong>super</strong>.activateOptions();
+<a name="110" href="#110">110</a>   }
+<a name="111" href="#111">111</a> 
+<a name="112" href="#112">112</a>   <em>/**<em>*</em></em>
+<a name="113" href="#113">113</a> <em>     Close this appender.</em>
+<a name="114" href="#114">114</a> <em>     &lt;p>This will mark the appender as closed and</em>
+<a name="115" href="#115">115</a> <em>     call then {@link #cleanUp} method.</em>
+<a name="116" href="#116">116</a> <em>  */</em>
+<a name="117" href="#117">117</a>   <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> close() {
+<a name="118" href="#118">118</a>     <strong>if</strong> (closed) {
+<a name="119" href="#119">119</a>       <strong>return</strong>;
+<a name="120" href="#120">120</a>     }
+<a name="121" href="#121">121</a> 
+<a name="122" href="#122">122</a>     <strong>this</strong>.closed = <strong>true</strong>;
+<a name="123" href="#123">123</a>     cleanUp();
+<a name="124" href="#124">124</a>   }
+<a name="125" href="#125">125</a> 
+<a name="126" href="#126">126</a>   <em>/**<em>*</em></em>
+<a name="127" href="#127">127</a> <em>     Close the Socket and release the underlying</em>
+<a name="128" href="#128">128</a> <em>     connector thread if it has been created</em>
+<a name="129" href="#129">129</a> <em>   */</em>
+<a name="130" href="#130">130</a>   <strong>public</strong> <strong>void</strong> cleanUp() {
+<a name="131" href="#131">131</a>     <strong>if</strong> (outSocket != <strong>null</strong>) {
+<a name="132" href="#132">132</a>       <strong>try</strong> {
+<a name="133" href="#133">133</a>         outSocket.close();
+<a name="134" href="#134">134</a>       } <strong>catch</strong> (Exception e) {
+<a name="135" href="#135">135</a>         LogLog.error(<span class="string">"Could not close outSocket."</span>, e);
+<a name="136" href="#136">136</a>       }
+<a name="137" href="#137">137</a> 
+<a name="138" href="#138">138</a>       outSocket = <strong>null</strong>;
+<a name="139" href="#139">139</a>     }
+<a name="140" href="#140">140</a>   }
+<a name="141" href="#141">141</a> 
+<a name="142" href="#142">142</a>   <strong>void</strong> connect() {
+<a name="143" href="#143">143</a>     <strong>if</strong> (<strong>this</strong>.address == <strong>null</strong>) {
+<a name="144" href="#144">144</a>       <strong>return</strong>;
+<a name="145" href="#145">145</a>     }
+<a name="146" href="#146">146</a> 
+<a name="147" href="#147">147</a>     <strong>try</strong> {
+<a name="148" href="#148">148</a>       <em class="comment">// First, close the previous connection if any.</em>
+<a name="149" href="#149">149</a>       cleanUp();
+<a name="150" href="#150">150</a>       outSocket = <strong>new</strong> MulticastSocket();
+<a name="151" href="#151">151</a>       outSocket.setTimeToLive(timeToLive);
+<a name="152" href="#152">152</a>     } <strong>catch</strong> (IOException e) {
+<a name="153" href="#153">153</a>       LogLog.error(<span class="string">"Error in connect method of MulticastAppender named "</span>+name, e);
+<a name="154" href="#154">154</a>     }
+<a name="155" href="#155">155</a>   }
+<a name="156" href="#156">156</a> 
+<a name="157" href="#157">157</a>   <strong>public</strong> <strong>void</strong> append(LoggingEvent event) {
+<a name="158" href="#158">158</a>     <strong>if</strong> (event == <strong>null</strong>) {
+<a name="159" href="#159">159</a>       <strong>return</strong>;
+<a name="160" href="#160">160</a>     }
+<a name="161" href="#161">161</a> 
+<a name="162" href="#162">162</a>     <strong>if</strong>(locationInfo) {
+<a name="163" href="#163">163</a> 	   event.getLocationInformation();
+<a name="164" href="#164">164</a> 	}
+<a name="165" href="#165">165</a> 
+<a name="166" href="#166">166</a>     <strong>if</strong> (outSocket != <strong>null</strong>) {
+<a name="167" href="#167">167</a>         event.setProperty(Constants.HOSTNAME_KEY, hostname);
+<a name="168" href="#168">168</a> 
+<a name="169" href="#169">169</a>         <strong>if</strong> (application != <strong>null</strong>) {
+<a name="170" href="#170">170</a>           event.setProperty(Constants.APPLICATION_KEY, application);
+<a name="171" href="#171">171</a>         }
+<a name="172" href="#172">172</a>       
+<a name="173" href="#173">173</a> 		<strong>if</strong>(locationInfo) {
+<a name="174" href="#174">174</a> 		   event.getLocationInformation();
+<a name="175" href="#175">175</a> 		}
+<a name="176" href="#176">176</a> 
+<a name="177" href="#177">177</a> 
+<a name="178" href="#178">178</a>       <strong>try</strong> {
+<a name="179" href="#179">179</a>         StringBuffer buf = <strong>new</strong> StringBuffer(layout.format(event));
+<a name="180" href="#180">180</a> 
+<a name="181" href="#181">181</a>         byte[] payload;
+<a name="182" href="#182">182</a>         <strong>if</strong>(encoding == <strong>null</strong>) {
+<a name="183" href="#183">183</a>           payload = buf.toString().getBytes();
+<a name="184" href="#184">184</a>         } <strong>else</strong> {
+<a name="185" href="#185">185</a>           payload = buf.toString().getBytes(encoding);
+<a name="186" href="#186">186</a>         }
+<a name="187" href="#187">187</a> 
+<a name="188" href="#188">188</a>         DatagramPacket dp =
+<a name="189" href="#189">189</a>            <strong>new</strong> DatagramPacket(payload, payload.length, address, port);
+<a name="190" href="#190">190</a>         outSocket.send(dp);
+<a name="191" href="#191">191</a>       } <strong>catch</strong> (IOException e) {
+<a name="192" href="#192">192</a>         outSocket = <strong>null</strong>;
+<a name="193" href="#193">193</a>         LogLog.warn(<span class="string">"Detected problem with Multicast connection: "</span> + e);
+<a name="194" href="#194">194</a>       }
+<a name="195" href="#195">195</a>     }
+<a name="196" href="#196">196</a>   }
+<a name="197" href="#197">197</a> 
+<a name="198" href="#198">198</a>   InetAddress getAddressByName(String host) {
+<a name="199" href="#199">199</a>     <strong>try</strong> {
+<a name="200" href="#200">200</a>       <strong>return</strong> InetAddress.getByName(host);
+<a name="201" href="#201">201</a>     } <strong>catch</strong> (Exception e) {
+<a name="202" href="#202">202</a>       LogLog.error(<span class="string">"Could not find address of ["</span> + host + <span class="string">"]."</span>, e);
+<a name="203" href="#203">203</a>       <strong>return</strong> <strong>null</strong>;
+<a name="204" href="#204">204</a>     }
+<a name="205" href="#205">205</a>   }
+<a name="206" href="#206">206</a> 
+<a name="207" href="#207">207</a>   <em>/**<em>*</em></em>
+<a name="208" href="#208">208</a> <em>     The &lt;b>RemoteHost&lt;/b> option takes a string value which should be</em>
+<a name="209" href="#209">209</a> <em>     the host name or ipaddress to send the multicast packets.</em>
+<a name="210" href="#210">210</a> <em>   */</em>
+<a name="211" href="#211">211</a>   <strong>public</strong> <strong>void</strong> setRemoteHost(String host) {
+<a name="212" href="#212">212</a>     remoteHost = host;
+<a name="213" href="#213">213</a>   }
+<a name="214" href="#214">214</a> 
+<a name="215" href="#215">215</a>   <em>/**<em>*</em></em>
+<a name="216" href="#216">216</a> <em>     Returns value of the &lt;b>RemoteHost&lt;/b> option.</em>
+<a name="217" href="#217">217</a> <em>   */</em>
+<a name="218" href="#218">218</a>   <strong>public</strong> String getRemoteHost() {
+<a name="219" href="#219">219</a>     <strong>return</strong> remoteHost;
+<a name="220" href="#220">220</a>   }
+<a name="221" href="#221">221</a> 
+<a name="222" href="#222">222</a>   <em>/**<em>*</em></em>
+<a name="223" href="#223">223</a> <em>  The &lt;b>LocationInfo&lt;/b> option takes a boolean value. If true,</em>
+<a name="224" href="#224">224</a> <em>  the information sent to the remote host will include location</em>
+<a name="225" href="#225">225</a> <em>  information. By default no location information is sent to the server.</em>
+<a name="226" href="#226">226</a> <em>   */</em>
+<a name="227" href="#227">227</a>   <strong>public</strong> <strong>void</strong> setLocationInfo(<strong>boolean</strong> locationInfo) {
+<a name="228" href="#228">228</a> 	  <strong>this</strong>.locationInfo = locationInfo;
+<a name="229" href="#229">229</a>   }
+<a name="230" href="#230">230</a> 
+<a name="231" href="#231">231</a>   <em>/**<em>*</em></em>
+<a name="232" href="#232">232</a> <em>   * Returns value of the &lt;b>LocationInfo&lt;/b> option.</em>
+<a name="233" href="#233">233</a> <em>   */</em>
+<a name="234" href="#234">234</a>   <strong>public</strong> <strong>boolean</strong> getLocationInfo() {
+<a name="235" href="#235">235</a> 	  <strong>return</strong> locationInfo;
+<a name="236" href="#236">236</a>   }
+<a name="237" href="#237">237</a> 
+<a name="238" href="#238">238</a>   <em>/**<em>*</em></em>
+<a name="239" href="#239">239</a> <em>      The &lt;b>Encoding&lt;/b> option specifies how the bytes are encoded.  If this option is not specified, </em>
+<a name="240" href="#240">240</a> <em>      the System encoding is used.</em>
+<a name="241" href="#241">241</a> <em>    */</em>
+<a name="242" href="#242">242</a>    <strong>public</strong> <strong>void</strong> setEncoding(String encoding) {
+<a name="243" href="#243">243</a>      <strong>this</strong>.encoding = encoding;
+<a name="244" href="#244">244</a>    }
+<a name="245" href="#245">245</a> 
+<a name="246" href="#246">246</a>    <em>/**<em>*</em></em>
+<a name="247" href="#247">247</a> <em>      Returns value of the &lt;b>Encoding&lt;/b> option.</em>
+<a name="248" href="#248">248</a> <em>    */</em>
+<a name="249" href="#249">249</a>    <strong>public</strong> String getEncoding() {
+<a name="250" href="#250">250</a>      <strong>return</strong> encoding;
+<a name="251" href="#251">251</a>    }
+<a name="252" href="#252">252</a>   <em>/**<em>*</em></em>
+<a name="253" href="#253">253</a> <em>     The &lt;b>App&lt;/b> option takes a string value which should be the name of the application getting logged.</em>
+<a name="254" href="#254">254</a> <em>     If property was already set (via system property), don't set here.</em>
+<a name="255" href="#255">255</a> <em>   */</em>
+<a name="256" href="#256">256</a>   <strong>public</strong> <strong>void</strong> setApplication(String app) {
+<a name="257" href="#257">257</a>     <strong>this</strong>.application = app;
+<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>     Returns value of the &lt;b>App&lt;/b> option.</em>
+<a name="262" href="#262">262</a> <em>   */</em>
+<a name="263" href="#263">263</a>   <strong>public</strong> String getApplication() {
+<a name="264" href="#264">264</a>     <strong>return</strong> application;
+<a name="265" href="#265">265</a>   }
+<a name="266" href="#266">266</a> 
+<a name="267" href="#267">267</a>   <em>/**<em>*</em></em>
+<a name="268" href="#268">268</a> <em>     The &lt;b>Time to live&lt;/b> option takes a positive integer representing</em>
+<a name="269" href="#269">269</a> <em>     the time to live value.</em>
+<a name="270" href="#270">270</a> <em>   */</em>
+<a name="271" href="#271">271</a>   <strong>public</strong> <strong>void</strong> setTimeToLive(<strong>int</strong> timeToLive) {
+<a name="272" href="#272">272</a>     <strong>this</strong>.timeToLive = timeToLive;
+<a name="273" href="#273">273</a>   }
+<a name="274" href="#274">274</a> 
+<a name="275" href="#275">275</a>   <em>/**<em>*</em></em>
+<a name="276" href="#276">276</a> <em>     Returns value of the &lt;b>Time to Live&lt;/b> option.</em>
+<a name="277" href="#277">277</a> <em>   */</em>
+<a name="278" href="#278">278</a>   <strong>public</strong> <strong>int</strong> getTimeToLive() {
+<a name="279" href="#279">279</a>     <strong>return</strong> timeToLive;
+<a name="280" href="#280">280</a>   }
+<a name="281" href="#281">281</a> 
+<a name="282" href="#282">282</a>   <em>/**<em>*</em></em>
+<a name="283" href="#283">283</a> <em>     The &lt;b>Port&lt;/b> option takes a positive integer representing</em>
+<a name="284" href="#284">284</a> <em>     the port where multicast packets will be sent.</em>
+<a name="285" href="#285">285</a> <em>   */</em>
+<a name="286" href="#286">286</a>   <strong>public</strong> <strong>void</strong> setPort(<strong>int</strong> port) {
+<a name="287" href="#287">287</a>     <strong>this</strong>.port = port;
+<a name="288" href="#288">288</a>   }
+<a name="289" href="#289">289</a> 
+<a name="290" href="#290">290</a>   <em>/**<em>*</em></em>
+<a name="291" href="#291">291</a> <em>     Returns value of the &lt;b>Port&lt;/b> option.</em>
+<a name="292" href="#292">292</a> <em>   */</em>
+<a name="293" href="#293">293</a>   <strong>public</strong> <strong>int</strong> getPort() {
+<a name="294" href="#294">294</a>     <strong>return</strong> port;
+<a name="295" href="#295">295</a>   }
+<a name="296" href="#296">296</a> 
+<a name="297" href="#297">297</a>   <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
+<a name="298" href="#298">298</a> <em class="comment">   * @see org.apache.log4j.net.NetworkBased#isActive()</em>
+<a name="299" href="#299">299</a> <em class="comment">   */</em>
+<a name="300" href="#300">300</a>   <strong>public</strong> <strong>boolean</strong> isActive() {
+<a name="301" href="#301">301</a>     <em class="comment">// TODO handle active/inactive</em>
+<a name="302" href="#302">302</a>     <strong>return</strong> <strong>true</strong>;
+<a name="303" href="#303">303</a>   }
+<a name="304" href="#304">304</a> 
+<a name="305" href="#305">305</a>     <em>/**<em>*</em></em>
+<a name="306" href="#306">306</a> <em>     * Gets whether appender requires a layout.</em>
+<a name="307" href="#307">307</a> <em>     * @return false</em>
+<a name="308" href="#308">308</a> <em>     */</em>
+<a name="309" href="#309">309</a>   <strong>public</strong> <strong>boolean</strong> requiresLayout() {
+<a name="310" href="#310">310</a>       <strong>return</strong> <strong>true</strong>;
+<a name="311" href="#311">311</a>   }
+<a name="312" href="#312">312</a> 
+<a name="313" href="#313">313</a> }
 </pre>
 <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
 </html>