bloritsch 02/01/31 08:20:36
Added: docs/logkit/api/org/apache/log/output/net
SocketOutputTarget.html
Log:
add new javadoc
Revision Changes Path
1.1
jakarta-avalon-site/docs/logkit/api/org/apache/log/output/net/SocketOutputTarget.html
Index: SocketOutputTarget.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0
Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd";>
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Thu Jan 31 11:17:52 EST 2002 -->
<TITLE>
LogKit API: Class SocketOutputTarget
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css"
TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<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="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/log/output/net/DatagramOutputTarget.html"><B>PREV
CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="SocketOutputTarget.html" TARGET="_top"><B>NO
FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | <A
HREF="#fields_inherited_from_class_org.apache.log.output.AbstractOutputTarget">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>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.log.output.net</FONT>
<BR>
Class SocketOutputTarget</H2>
<PRE>
java.lang.Object
|
+--<A
HREF="../../../../../org/apache/log/output/AbstractTarget.html">org.apache.log.output.AbstractTarget</A>
|
+--<A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html">org.apache.log.output.AbstractOutputTarget</A>
|
+--<B>org.apache.log.output.net.SocketOutputTarget</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A
HREF="../../../../../org/apache/log/ErrorAware.html">ErrorAware</A>, <A
HREF="../../../../../org/apache/log/LogTarget.html">LogTarget</A></DD>
</DL>
<HR>
<DL>
<DT>public class <B>SocketOutputTarget</B><DT>extends <A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html">AbstractOutputTarget</A></DL>
<P>
SocketOutputTarget
Useful for writing the output to a TCP/IP client socket.
<P>
<DL>
<DT><B>Version: </B><DD> </DD>
<DT><B>Author: </B><DD><a href="mailto:[EMAIL PROTECTED]"> Rajendra Ghorpade
</a></DD>
</DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A
NAME="fields_inherited_from_class_org.apache.log.output.AbstractOutputTarget"><!--
--></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Fields inherited from class org.apache.log.output.<A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html">AbstractOutputTarget</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html#m_formatter">m_formatter</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A
HREF="../../../../../org/apache/log/output/net/SocketOutputTarget.html#SocketOutputTarget(java.net.InetAddress,
int)">SocketOutputTarget</A></B>(java.net.InetAddress address,
int port)</CODE>
<BR>
Creates output
target with the end point specified by the address and port</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A
HREF="../../../../../org/apache/log/output/net/SocketOutputTarget.html#SocketOutputTarget(java.lang.String,
int)">SocketOutputTarget</A></B>(java.lang.String host,
int port)</CODE>
<BR>
Creates the
output target with the end point specified by host and port</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></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/log/output/net/SocketOutputTarget.html#close()">close</A></B>()</CODE>
<BR>
Shutdown
target.</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/log/output/net/SocketOutputTarget.html#doProcessEvent(org.apache.log.LogEvent)">doProcessEvent</A></B>(<A
HREF="../../../../../org/apache/log/LogEvent.html">LogEvent</A> event)</CODE>
<BR>
To process the
LogEvent</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/log/output/net/SocketOutputTarget.html#write(org.apache.log.LogEvent)">write</A></B>(<A
HREF="../../../../../org/apache/log/LogEvent.html">LogEvent</A> event)</CODE>
<BR>
Writes the output
as a LogEvent without formatting.</TD>
</TR>
</TABLE>
<A
NAME="methods_inherited_from_class_org.apache.log.output.AbstractOutputTarget"><!--
--></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class org.apache.log.output.<A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html">AbstractOutputTarget</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html#getFormatter()">getFormatter</A>,
<A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html#open()">open</A>,
<A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html#output(java.lang.String)">output</A>,
<A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html#setFormatter(org.apache.log.format.Formatter)">setFormatter</A>,
<A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html#write(java.lang.String)">write</A></CODE></TD>
</TR>
</TABLE>
<A
NAME="methods_inherited_from_class_org.apache.log.output.AbstractTarget"><!--
--></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class org.apache.log.output.<A
HREF="../../../../../org/apache/log/output/AbstractTarget.html">AbstractTarget</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A
HREF="../../../../../org/apache/log/output/AbstractTarget.html#error(java.lang.String,
java.lang.Throwable)">error</A>, <A
HREF="../../../../../org/apache/log/output/AbstractTarget.html#getErrorHandler()">getErrorHandler</A>,
<A
HREF="../../../../../org/apache/log/output/AbstractTarget.html#isOpen()">isOpen</A>,
<A
HREF="../../../../../org/apache/log/output/AbstractTarget.html#processEvent(org.apache.log.LogEvent)">processEvent</A>,
<A
HREF="../../../../../org/apache/log/output/AbstractTarget.html#setErrorHandler(org.apache.log.ErrorHandler)">setErrorHandler</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="SocketOutputTarget(java.net.InetAddress, int)"><!-- --></A><H3>
SocketOutputTarget</H3>
<PRE>
public <B>SocketOutputTarget</B>(java.net.InetAddress address,
int port)
throws java.io.IOException</PRE>
<DL>
<DD>Creates output target with the end point specified by the address and
port<DD><DL>
<DT><B>Parameters:</B><DD><CODE>address</CODE> - end point
address<DD><CODE>port</CODE> - the end point
port<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if an I/O error
ocurrs when creating socket</DL>
</DD>
</DL>
<HR>
<A NAME="SocketOutputTarget(java.lang.String, int)"><!-- --></A><H3>
SocketOutputTarget</H3>
<PRE>
public <B>SocketOutputTarget</B>(java.lang.String host,
int port)
throws java.io.IOException</PRE>
<DL>
<DD>Creates the output target with the end point specified by host and
port<DD><DL>
<DT><B>Parameters:</B><DD><CODE>host</CODE> - end point
host<DD><CODE>port</CODE> - the end point
port<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if an I/O error
ocurrs when creating socket</DL>
</DD>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="write(org.apache.log.LogEvent)"><!-- --></A><H3>
write</H3>
<PRE>
protected void <B>write</B>(<A
HREF="../../../../../org/apache/log/LogEvent.html">LogEvent</A> event)</PRE>
<DL>
<DD>Writes the output as a LogEvent without formatting.
Formatting ia applied on the server side where it is log.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>event</CODE> - the LogEvent</DL>
</DD>
</DL>
<HR>
<A NAME="doProcessEvent(org.apache.log.LogEvent)"><!-- --></A><H3>
doProcessEvent</H3>
<PRE>
protected void <B>doProcessEvent</B>(<A
HREF="../../../../../org/apache/log/LogEvent.html">LogEvent</A> event)</PRE>
<DL>
<DD>To process the LogEvent<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html#doProcessEvent(org.apache.log.LogEvent)">doProcessEvent</A></CODE>
in class <CODE><A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html">AbstractOutputTarget</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>event</CODE> - the LogEvent</DL>
</DD>
</DL>
<HR>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()</PRE>
<DL>
<DD>Shutdown target.
Attempting to write to target after close() will cause errors to be
logged.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html#close()">close</A></CODE>
in class <CODE><A
HREF="../../../../../org/apache/log/output/AbstractOutputTarget.html">AbstractOutputTarget</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<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="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/log/output/net/DatagramOutputTarget.html"><B>PREV
CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="SocketOutputTarget.html" TARGET="_top"><B>NO
FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | <A
HREF="#fields_inherited_from_class_org.apache.log.output.AbstractOutputTarget">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>
<!-- =========== END OF NAVBAR =========== -->
<HR>
Copyright � 2001 Apache Jakarta Project. All Rights Reserved.
</BODY>
</HTML>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
