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/07/21 19:50:44 UTC
svn commit: r558362 [12/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...
Added: logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketHubReceiver.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketHubReceiver.html?view=auto&rev=558362
==============================================================================
--- logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketHubReceiver.html (added)
+++ logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketHubReceiver.html Sat Jul 21 10:50:33 2007
@@ -0,0 +1,911 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.6.0) -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+SocketHubReceiver (Apache Receivers Companion for log4j 1.2. 1.1-SNAPSHOT API)
+</TITLE>
+
+<META NAME="date" CONTENT="2007-07-21">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="SocketHubReceiver (Apache Receivers Companion for log4j 1.2. 1.1-SNAPSHOT API)";
+ }
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+<HR>
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SocketHubReceiver.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../org/apache/log4j/net/PortBased.html" title="interface in org.apache.log4j.net"><B>PREV CLASS</B></A>
+ <A HREF="../../../../org/apache/log4j/net/SocketNode13.html" title="class in org.apache.log4j.net"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?org/apache/log4j/net/SocketHubReceiver.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="SocketHubReceiver.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.log4j.net</FONT>
+<BR>
+Class SocketHubReceiver</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">org.apache.log4j.spi.ComponentBase
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">org.apache.log4j.plugins.PluginSkeleton
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">org.apache.log4j.plugins.Receiver
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.log4j.net.SocketHubReceiver</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>java.util.EventListener, <A HREF="../../../../org/apache/log4j/net/NetworkBased.html" title="interface in org.apache.log4j.net">NetworkBased</A>, <A HREF="../../../../org/apache/log4j/net/PortBased.html" title="interface in org.apache.log4j.net">PortBased</A>, <A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A>, org.apache.log4j.plugins.Plugin, org.apache.log4j.spi.Component, org.apache.log4j.spi.OptionHandler, org.apache.log4j.spi.Thresholdable</DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public class <B>SocketHubReceiver</B><DT>extends org.apache.log4j.plugins.Receiver<DT>implements <A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A>, <A HREF="../../../../org/apache/log4j/net/PortBased.html" title="interface in org.apache.log4j.net">PortBased</A></DL>
+</PRE>
+
+<P>
+SocketHubReceiver receives a remote logging event on a configured
+ socket and "posts" it to a LoggerRepository as if the event was
+ generated locally. This class is designed to receive events from
+ the SocketHubAppender class (or classes that send compatible events).
+
+ <p>Once the event has been "posted", it will be handled by the
+ appenders currently configured in the LoggerRespository.
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>1.3</DD>
+<DT><B>Author:</B></DT>
+ <DD>Mark Womack, Ceki Gülcü, Paul Smith (psmith@apache.org)</DD>
+</DL>
+<HR>
+
+<P>
+<!-- =========== FIELD SUMMARY =========== -->
+
+<A NAME="field_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Field Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#active">active</A></B></CODE>
+
+<BR>
+ Active.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected org.apache.log4j.net.SocketHubReceiver.Connector</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#connector">connector</A></B></CODE>
+
+<BR>
+ Connector.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#host">host</A></B></CODE>
+
+<BR>
+ Host.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#port">port</A></B></CODE>
+
+<BR>
+ Port.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#reconnectionDelay">reconnectionDelay</A></B></CODE>
+
+<BR>
+ Reconnection delay.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected java.net.Socket</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#socket">socket</A></B></CODE>
+
+<BR>
+ Socket.</TD>
+</TR>
+</TABLE>
+ <A NAME="fields_inherited_from_class_org.apache.log4j.plugins.Receiver"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Fields inherited from class org.apache.log4j.plugins.Receiver</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>thresholdLevel</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="fields_inherited_from_class_org.apache.log4j.plugins.PluginSkeleton"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Fields inherited from class org.apache.log4j.plugins.PluginSkeleton</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>name</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="fields_inherited_from_class_org.apache.log4j.spi.ComponentBase"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Fields inherited from class org.apache.log4j.spi.ComponentBase</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>repository</CODE></TD>
+</TR>
+</TABLE>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#SocketHubReceiver()">SocketHubReceiver</A></B>()</CODE>
+
+<BR>
+ Create new instance.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#SocketHubReceiver(java.lang.String, int)">SocketHubReceiver</A></B>(java.lang.String h,
+ int p)</CODE>
+
+<BR>
+ Create new instance.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#SocketHubReceiver(java.lang.String, int, org.apache.log4j.spi.LoggerRepository)">SocketHubReceiver</A></B>(java.lang.String h,
+ int p,
+ org.apache.log4j.spi.LoggerRepository repo)</CODE>
+
+<BR>
+ Create new instance.</TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#activateOptions()">activateOptions</A></B>()</CODE>
+
+<BR>
+ Starts the SocketReceiver with the current options.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#addSocketNodeEventListener(org.apache.log4j.net.SocketNodeEventListener)">addSocketNodeEventListener</A></B>(<A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A> l)</CODE>
+
+<BR>
+ Adds a SocketNodeEventListener to this receiver to be notified
+ of SocketNode events.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#getHost()">getHost</A></B>()</CODE>
+
+<BR>
+ Get the remote host to connect to for logging events.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#getPort()">getPort</A></B>()</CODE>
+
+<BR>
+ Get the remote port to connect to for logging events.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#getReconnectionDelay()">getReconnectionDelay</A></B>()</CODE>
+
+<BR>
+ Returns value of the <b>ReconnectionDelay</b> option.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#isActive()">isActive</A></B>()</CODE>
+
+<BR>
+ Returns true if this receiver is active.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#isEquivalent(org.apache.log4j.plugins.Plugin)">isEquivalent</A></B>(org.apache.log4j.plugins.Plugin testPlugin)</CODE>
+
+<BR>
+ Returns true if the receiver is the same class and they are
+ configured for the same properties, and super class also considers
+ them to be equivalent.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#removeSocketNodeEventListener(org.apache.log4j.net.SocketNodeEventListener)">removeSocketNodeEventListener</A></B>(<A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A> l)</CODE>
+
+<BR>
+ Removes a specific SocketNodeEventListener from this instance
+ so that it will no longer be notified of SocketNode events.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#setActive(boolean)">setActive</A></B>(boolean b)</CODE>
+
+<BR>
+ Sets the flag to indicate if receiver is active or not.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#setHost(java.lang.String)">setHost</A></B>(java.lang.String remoteHost)</CODE>
+
+<BR>
+ Configures the Host property, this will require activateOptions
+ to be called for this to take effect.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#setPort(int)">setPort</A></B>(int p)</CODE>
+
+<BR>
+ Set the remote port to connect to for logging events.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#setPort(java.lang.String)">setPort</A></B>(java.lang.String remoteHost)</CODE>
+
+<BR>
+ Set the remote host to connect to for logging events.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#setReconnectionDelay(int)">setReconnectionDelay</A></B>(int delay)</CODE>
+
+<BR>
+ The <b>ReconnectionDelay</b> option takes a positive integer
+ representing the number of milliseconds to wait between each
+ failed connection attempt to the server.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#shutdown()">shutdown</A></B>()</CODE>
+
+<BR>
+ Called when the receiver should be stopped.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#socketClosedEvent(java.lang.Exception)">socketClosedEvent</A></B>(java.lang.Exception e)</CODE>
+
+<BR>
+ Listen for a socketClosedEvent from the SocketNode.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html#socketOpened(java.lang.String)">socketOpened</A></B>(java.lang.String remoteInfo)</CODE>
+
+<BR>
+ This method does nothing.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_org.apache.log4j.plugins.Receiver"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class org.apache.log4j.plugins.Receiver</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>doPost, getThreshold, isAsSevereAsThreshold, setThreshold</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_org.apache.log4j.plugins.PluginSkeleton"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class org.apache.log4j.plugins.PluginSkeleton</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getLoggerRepository, getName, removePropertyChangeListener, removePropertyChangeListener, setLoggerRepository, setName</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_org.apache.log4j.spi.ComponentBase"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class org.apache.log4j.spi.ComponentBase</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>getLogger, getNonFloodingLogger, resetErrorCount</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_org.apache.log4j.net.NetworkBased"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from interface org.apache.log4j.net.<A HREF="../../../../org/apache/log4j/net/NetworkBased.html" title="interface in org.apache.log4j.net">NetworkBased</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="../../../../org/apache/log4j/net/NetworkBased.html#getName()">getName</A></CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+<A NAME="field_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="host"><!-- --></A><H3>
+host</H3>
+<PRE>
+protected java.lang.String <B>host</B></PRE>
+<DL>
+<DD>Host.
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="port"><!-- --></A><H3>
+port</H3>
+<PRE>
+protected int <B>port</B></PRE>
+<DL>
+<DD>Port.
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="reconnectionDelay"><!-- --></A><H3>
+reconnectionDelay</H3>
+<PRE>
+protected int <B>reconnectionDelay</B></PRE>
+<DL>
+<DD>Reconnection delay.
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="active"><!-- --></A><H3>
+active</H3>
+<PRE>
+protected boolean <B>active</B></PRE>
+<DL>
+<DD>Active.
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="connector"><!-- --></A><H3>
+connector</H3>
+<PRE>
+protected org.apache.log4j.net.SocketHubReceiver.Connector <B>connector</B></PRE>
+<DL>
+<DD>Connector.
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="socket"><!-- --></A><H3>
+socket</H3>
+<PRE>
+protected java.net.Socket <B>socket</B></PRE>
+<DL>
+<DD>Socket.
+<P>
+<DL>
+</DL>
+</DL>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="SocketHubReceiver()"><!-- --></A><H3>
+SocketHubReceiver</H3>
+<PRE>
+public <B>SocketHubReceiver</B>()</PRE>
+<DL>
+<DD>Create new instance.
+<P>
+</DL>
+<HR>
+
+<A NAME="SocketHubReceiver(java.lang.String, int)"><!-- --></A><H3>
+SocketHubReceiver</H3>
+<PRE>
+public <B>SocketHubReceiver</B>(java.lang.String h,
+ int p)</PRE>
+<DL>
+<DD>Create new instance.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>h</CODE> - host<DD><CODE>p</CODE> - port</DL>
+</DL>
+<HR>
+
+<A NAME="SocketHubReceiver(java.lang.String, int, org.apache.log4j.spi.LoggerRepository)"><!-- --></A><H3>
+SocketHubReceiver</H3>
+<PRE>
+public <B>SocketHubReceiver</B>(java.lang.String h,
+ int p,
+ org.apache.log4j.spi.LoggerRepository repo)</PRE>
+<DL>
+<DD>Create new instance.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>h</CODE> - host<DD><CODE>p</CODE> - port<DD><CODE>repo</CODE> - logger repository</DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="addSocketNodeEventListener(org.apache.log4j.net.SocketNodeEventListener)"><!-- --></A><H3>
+addSocketNodeEventListener</H3>
+<PRE>
+public void <B>addSocketNodeEventListener</B>(<A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A> l)</PRE>
+<DL>
+<DD>Adds a SocketNodeEventListener to this receiver to be notified
+ of SocketNode events.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>l</CODE> - listener</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="removeSocketNodeEventListener(org.apache.log4j.net.SocketNodeEventListener)"><!-- --></A><H3>
+removeSocketNodeEventListener</H3>
+<PRE>
+public void <B>removeSocketNodeEventListener</B>(<A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A> l)</PRE>
+<DL>
+<DD>Removes a specific SocketNodeEventListener from this instance
+ so that it will no longer be notified of SocketNode events.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>l</CODE> - listener</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getHost()"><!-- --></A><H3>
+getHost</H3>
+<PRE>
+public java.lang.String <B>getHost</B>()</PRE>
+<DL>
+<DD>Get the remote host to connect to for logging events.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>host</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setHost(java.lang.String)"><!-- --></A><H3>
+setHost</H3>
+<PRE>
+public void <B>setHost</B>(java.lang.String remoteHost)</PRE>
+<DL>
+<DD>Configures the Host property, this will require activateOptions
+ to be called for this to take effect.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>remoteHost</CODE> - address of remote host.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setPort(java.lang.String)"><!-- --></A><H3>
+setPort</H3>
+<PRE>
+public void <B>setPort</B>(java.lang.String remoteHost)</PRE>
+<DL>
+<DD>Set the remote host to connect to for logging events.
+ Equivalent to setHost.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>remoteHost</CODE> - address of remote host.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPort()"><!-- --></A><H3>
+getPort</H3>
+<PRE>
+public int <B>getPort</B>()</PRE>
+<DL>
+<DD>Get the remote port to connect to for logging events.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/log4j/net/PortBased.html#getPort()">getPort</A></CODE> in interface <CODE><A HREF="../../../../org/apache/log4j/net/PortBased.html" title="interface in org.apache.log4j.net">PortBased</A></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>port</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setPort(int)"><!-- --></A><H3>
+setPort</H3>
+<PRE>
+public void <B>setPort</B>(int p)</PRE>
+<DL>
+<DD>Set the remote port to connect to for logging events.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>p</CODE> - port</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setReconnectionDelay(int)"><!-- --></A><H3>
+setReconnectionDelay</H3>
+<PRE>
+public void <B>setReconnectionDelay</B>(int delay)</PRE>
+<DL>
+<DD>The <b>ReconnectionDelay</b> option takes a positive integer
+ representing the number of milliseconds to wait between each
+ failed connection attempt to the server. The default value of
+ this option is 30000 which corresponds to 30 seconds.
+
+ <p>Setting this option to zero turns off reconnection
+ capability.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>delay</CODE> - milliseconds to wait or zero to not reconnect.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getReconnectionDelay()"><!-- --></A><H3>
+getReconnectionDelay</H3>
+<PRE>
+public int <B>getReconnectionDelay</B>()</PRE>
+<DL>
+<DD>Returns value of the <b>ReconnectionDelay</b> option.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>value of reconnection delay option.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isEquivalent(org.apache.log4j.plugins.Plugin)"><!-- --></A><H3>
+isEquivalent</H3>
+<PRE>
+public boolean <B>isEquivalent</B>(org.apache.log4j.plugins.Plugin testPlugin)</PRE>
+<DL>
+<DD>Returns true if the receiver is the same class and they are
+ configured for the same properties, and super class also considers
+ them to be equivalent. This is used by PluginRegistry when determining
+ if the a similarly configured receiver is being started.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>isEquivalent</CODE> in interface <CODE>org.apache.log4j.plugins.Plugin</CODE><DT><B>Overrides:</B><DD><CODE>isEquivalent</CODE> in class <CODE>org.apache.log4j.plugins.PluginSkeleton</CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>testPlugin</CODE> - The plugin to test equivalency against.
+<DT><B>Returns:</B><DD>boolean True if the testPlugin is equivalent to this plugin.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isActive()"><!-- --></A><H3>
+isActive</H3>
+<PRE>
+public boolean <B>isActive</B>()</PRE>
+<DL>
+<DD>Returns true if this receiver is active.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/log4j/net/NetworkBased.html#isActive()">isActive</A></CODE> in interface <CODE><A HREF="../../../../org/apache/log4j/net/NetworkBased.html" title="interface in org.apache.log4j.net">NetworkBased</A></CODE><DT><B>Specified by:</B><DD><CODE>isActive</CODE> in interface <CODE>org.apache.log4j.plugins.Plugin</CODE><DT><B>Overrides:</B><DD><CODE>isActive</CODE> in class <CODE>org.apache.log4j.plugins.PluginSkeleton</CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>true if receiver is active</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setActive(boolean)"><!-- --></A><H3>
+setActive</H3>
+<PRE>
+protected void <B>setActive</B>(boolean b)</PRE>
+<DL>
+<DD>Sets the flag to indicate if receiver is active or not.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>b</CODE> - new value</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="activateOptions()"><!-- --></A><H3>
+activateOptions</H3>
+<PRE>
+public void <B>activateOptions</B>()</PRE>
+<DL>
+<DD>Starts the SocketReceiver with the current options.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>activateOptions</CODE> in interface <CODE>org.apache.log4j.spi.OptionHandler</CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="shutdown()"><!-- --></A><H3>
+shutdown</H3>
+<PRE>
+public void <B>shutdown</B>()</PRE>
+<DL>
+<DD>Called when the receiver should be stopped. Closes the socket
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>shutdown</CODE> in interface <CODE>org.apache.log4j.plugins.Plugin</CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="socketClosedEvent(java.lang.Exception)"><!-- --></A><H3>
+socketClosedEvent</H3>
+<PRE>
+public void <B>socketClosedEvent</B>(java.lang.Exception e)</PRE>
+<DL>
+<DD>Listen for a socketClosedEvent from the SocketNode. Reopen the
+ socket if this receiver is still active.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html#socketClosedEvent(java.lang.Exception)">socketClosedEvent</A></CODE> in interface <CODE><A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>e</CODE> - exception not used.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="socketOpened(java.lang.String)"><!-- --></A><H3>
+socketOpened</H3>
+<PRE>
+public void <B>socketOpened</B>(java.lang.String remoteInfo)</PRE>
+<DL>
+<DD>This method does nothing.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html#socketOpened(java.lang.String)">socketOpened</A></CODE> in interface <CODE><A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>remoteInfo</CODE> - remote info.</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SocketHubReceiver.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../org/apache/log4j/net/PortBased.html" title="interface in org.apache.log4j.net"><B>PREV CLASS</B></A>
+ <A HREF="../../../../org/apache/log4j/net/SocketNode13.html" title="class in org.apache.log4j.net"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?org/apache/log4j/net/SocketHubReceiver.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="SocketHubReceiver.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2007 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
+</BODY>
+</HTML>
Propchange: logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketHubReceiver.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketNode13.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketNode13.html?view=auto&rev=558362
==============================================================================
--- logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketNode13.html (added)
+++ logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketNode13.html Sat Jul 21 10:50:33 2007
@@ -0,0 +1,464 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.6.0) -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+SocketNode13 (Apache Receivers Companion for log4j 1.2. 1.1-SNAPSHOT API)
+</TITLE>
+
+<META NAME="date" CONTENT="2007-07-21">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="SocketNode13 (Apache Receivers Companion for log4j 1.2. 1.1-SNAPSHOT API)";
+ }
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+<HR>
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SocketNode13.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html" title="class in org.apache.log4j.net"><B>PREV CLASS</B></A>
+ <A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?org/apache/log4j/net/SocketNode13.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="SocketNode13.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.log4j.spi.ComponentBase">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.log4j.net</FONT>
+<BR>
+Class SocketNode13</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">org.apache.log4j.spi.ComponentBase
+ <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.log4j.net.SocketNode13</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Runnable, org.apache.log4j.plugins.Pauseable, org.apache.log4j.spi.Component</DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public class <B>SocketNode13</B><DT>extends org.apache.log4j.spi.ComponentBase<DT>implements java.lang.Runnable, org.apache.log4j.plugins.Pauseable</DL>
+</PRE>
+
+<P>
+Read <CODE>LoggingEvent</CODE> objects sent from a remote client using
+ Sockets (TCP). These logging events are logged according to local
+ policy, as if they were generated locally.
+
+ <p>For example, the socket node might decide to log events to a
+ local file and also resent them to a second socket node.
+
+ Implementation lifted from org.apache.log4j.net.SocketNode
+ in log4j 1.3 and renamed to prevent collision with
+ log4j 1.2 implementation.
+<P>
+
+<P>
+<DL>
+<DT><B>Author:</B></DT>
+ <DD>Ceki Gülcü, Paul Smith (psmith@apache.org)</DD>
+</DL>
+<HR>
+
+<P>
+<!-- =========== FIELD SUMMARY =========== -->
+
+<A NAME="field_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Field Summary</B></FONT></TH>
+</TR>
+</TABLE>
+ <A NAME="fields_inherited_from_class_org.apache.log4j.spi.ComponentBase"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Fields inherited from class org.apache.log4j.spi.ComponentBase</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>repository</CODE></TD>
+</TR>
+</TABLE>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketNode13.html#SocketNode13(java.net.Socket, org.apache.log4j.spi.LoggerRepository)">SocketNode13</A></B>(java.net.Socket s,
+ org.apache.log4j.spi.LoggerRepository hierarchy)</CODE>
+
+<BR>
+ Constructor for socket and logger repository.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketNode13.html#SocketNode13(java.net.Socket, org.apache.log4j.plugins.Receiver)">SocketNode13</A></B>(java.net.Socket s,
+ org.apache.log4j.plugins.Receiver r)</CODE>
+
+<BR>
+ Constructor for socket and receiver.</TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketNode13.html#addSocketNodeEventListener(org.apache.log4j.net.SocketNodeEventListener)">addSocketNodeEventListener</A></B>(<A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A> listener)</CODE>
+
+<BR>
+ Adds the listener to the list of listeners to be notified of the
+ respective event.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketNode13.html#isPaused()">isPaused</A></B>()</CODE>
+
+<BR>
+ Get if node is paused.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketNode13.html#removeSocketNodeEventListener(org.apache.log4j.net.SocketNodeEventListener)">removeSocketNodeEventListener</A></B>(<A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A> listener)</CODE>
+
+<BR>
+ Removes the registered Listener from this instances list of
+ listeners.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketNode13.html#run()">run</A></B>()</CODE>
+
+<BR>
+ Deserialize events from socket until interrupted.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketNode13.html#setListener(org.apache.log4j.net.SocketNodeEventListener)">setListener</A></B>(<A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A> l)</CODE>
+
+<BR>
+ <B>Deprecated.</B> <I>Now supports mutliple listeners, this method
+ simply invokes the removeSocketNodeEventListener() to remove
+ the listener, and then readds it.</I></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketNode13.html#setPaused(boolean)">setPaused</A></B>(boolean b)</CODE>
+
+<BR>
+ Sets if node is paused.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_org.apache.log4j.spi.ComponentBase"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class org.apache.log4j.spi.ComponentBase</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>getLogger, getLoggerRepository, getNonFloodingLogger, resetErrorCount, setLoggerRepository</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="SocketNode13(java.net.Socket, org.apache.log4j.spi.LoggerRepository)"><!-- --></A><H3>
+SocketNode13</H3>
+<PRE>
+public <B>SocketNode13</B>(java.net.Socket s,
+ org.apache.log4j.spi.LoggerRepository hierarchy)</PRE>
+<DL>
+<DD>Constructor for socket and logger repository.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>s</CODE> - socket<DD><CODE>hierarchy</CODE> - logger repository</DL>
+</DL>
+<HR>
+
+<A NAME="SocketNode13(java.net.Socket, org.apache.log4j.plugins.Receiver)"><!-- --></A><H3>
+SocketNode13</H3>
+<PRE>
+public <B>SocketNode13</B>(java.net.Socket s,
+ org.apache.log4j.plugins.Receiver r)</PRE>
+<DL>
+<DD>Constructor for socket and receiver.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>s</CODE> - socket<DD><CODE>r</CODE> - receiver</DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="setListener(org.apache.log4j.net.SocketNodeEventListener)"><!-- --></A><H3>
+setListener</H3>
+<PRE>
+public void <B>setListener</B>(<A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A> l)</PRE>
+<DL>
+<DD><B>Deprecated.</B> <I>Now supports mutliple listeners, this method
+ simply invokes the removeSocketNodeEventListener() to remove
+ the listener, and then readds it.</I>
+<P>
+<DD>Set the event listener on this node.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>l</CODE> - listener</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="addSocketNodeEventListener(org.apache.log4j.net.SocketNodeEventListener)"><!-- --></A><H3>
+addSocketNodeEventListener</H3>
+<PRE>
+public void <B>addSocketNodeEventListener</B>(<A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A> listener)</PRE>
+<DL>
+<DD>Adds the listener to the list of listeners to be notified of the
+ respective event.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener to add to the list</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="removeSocketNodeEventListener(org.apache.log4j.net.SocketNodeEventListener)"><!-- --></A><H3>
+removeSocketNodeEventListener</H3>
+<PRE>
+public void <B>removeSocketNodeEventListener</B>(<A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net">SocketNodeEventListener</A> listener)</PRE>
+<DL>
+<DD>Removes the registered Listener from this instances list of
+ listeners. If the listener has not been registered, then invoking
+ this method has no effect.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the SocketNodeEventListener to remove</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="run()"><!-- --></A><H3>
+run</H3>
+<PRE>
+public void <B>run</B>()</PRE>
+<DL>
+<DD>Deserialize events from socket until interrupted.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>run</CODE> in interface <CODE>java.lang.Runnable</CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setPaused(boolean)"><!-- --></A><H3>
+setPaused</H3>
+<PRE>
+public void <B>setPaused</B>(boolean b)</PRE>
+<DL>
+<DD>Sets if node is paused.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>setPaused</CODE> in interface <CODE>org.apache.log4j.plugins.Pauseable</CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>b</CODE> - new value</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isPaused()"><!-- --></A><H3>
+isPaused</H3>
+<PRE>
+public boolean <B>isPaused</B>()</PRE>
+<DL>
+<DD>Get if node is paused.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>isPaused</CODE> in interface <CODE>org.apache.log4j.plugins.Pauseable</CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>true if pause.</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SocketNode13.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html" title="class in org.apache.log4j.net"><B>PREV CLASS</B></A>
+ <A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html" title="interface in org.apache.log4j.net"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?org/apache/log4j/net/SocketNode13.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="SocketNode13.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.log4j.spi.ComponentBase">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2007 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
+</BODY>
+</HTML>
Propchange: logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketNode13.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketNodeEventListener.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketNodeEventListener.html?view=auto&rev=558362
==============================================================================
--- logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketNodeEventListener.html (added)
+++ logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketNodeEventListener.html Sat Jul 21 10:50:33 2007
@@ -0,0 +1,254 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.6.0) -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+SocketNodeEventListener (Apache Receivers Companion for log4j 1.2. 1.1-SNAPSHOT API)
+</TITLE>
+
+<META NAME="date" CONTENT="2007-07-21">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="SocketNodeEventListener (Apache Receivers Companion for log4j 1.2. 1.1-SNAPSHOT API)";
+ }
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+<HR>
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SocketNodeEventListener.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../org/apache/log4j/net/SocketNode13.html" title="class in org.apache.log4j.net"><B>PREV CLASS</B></A>
+ <A HREF="../../../../org/apache/log4j/net/SocketReceiver.html" title="class in org.apache.log4j.net"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?org/apache/log4j/net/SocketNodeEventListener.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="SocketNodeEventListener.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.log4j.net</FONT>
+<BR>
+Interface SocketNodeEventListener</H2>
+<DL>
+<DT><B>All Superinterfaces:</B> <DD>java.util.EventListener</DD>
+</DL>
+<DL>
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/log4j/net/SocketHubReceiver.html" title="class in org.apache.log4j.net">SocketHubReceiver</A></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public interface <B>SocketNodeEventListener</B><DT>extends java.util.EventListener</DL>
+</PRE>
+
+<P>
+Interface used to listen for <CODE>SocketNode</CODE> related
+ events. Clients register an instance of the interface and the
+ instance is called back when the various events occur.
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>1.3</DD>
+<DT><B>Author:</B></DT>
+ <DD>Mark Womack, Paul Smith (psmith@apache.org)</DD>
+</DL>
+<HR>
+
+<P>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html#socketClosedEvent(java.lang.Exception)">socketClosedEvent</A></B>(java.lang.Exception e)</CODE>
+
+<BR>
+ Called when the socket the node was given has been closed.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/log4j/net/SocketNodeEventListener.html#socketOpened(java.lang.String)">socketOpened</A></B>(java.lang.String remoteInfo)</CODE>
+
+<BR>
+ Called when the SocketNode is created and begins awaiting data.</TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="socketOpened(java.lang.String)"><!-- --></A><H3>
+socketOpened</H3>
+<PRE>
+void <B>socketOpened</B>(java.lang.String remoteInfo)</PRE>
+<DL>
+<DD>Called when the SocketNode is created and begins awaiting data.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>remoteInfo</CODE> - remote info</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="socketClosedEvent(java.lang.Exception)"><!-- --></A><H3>
+socketClosedEvent</H3>
+<PRE>
+void <B>socketClosedEvent</B>(java.lang.Exception e)</PRE>
+<DL>
+<DD>Called when the socket the node was given has been closed.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>e</CODE> - exception</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SocketNodeEventListener.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../org/apache/log4j/net/SocketNode13.html" title="class in org.apache.log4j.net"><B>PREV CLASS</B></A>
+ <A HREF="../../../../org/apache/log4j/net/SocketReceiver.html" title="class in org.apache.log4j.net"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?org/apache/log4j/net/SocketNodeEventListener.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="SocketNodeEventListener.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2007 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
+</BODY>
+</HTML>
Propchange: logging/site/trunk/docs/log4j/companions/receivers/apidocs/org/apache/log4j/net/SocketNodeEventListener.html
------------------------------------------------------------------------------
svn:mime-type = text/html