diff options
Diffstat (limited to 'libraries/oscP5/reference/netP5/AbstractTcpClient.html')
| -rw-r--r-- | libraries/oscP5/reference/netP5/AbstractTcpClient.html | 869 |
1 files changed, 869 insertions, 0 deletions
diff --git a/libraries/oscP5/reference/netP5/AbstractTcpClient.html b/libraries/oscP5/reference/netP5/AbstractTcpClient.html new file mode 100644 index 0000000..afc5010 --- /dev/null +++ b/libraries/oscP5/reference/netP5/AbstractTcpClient.html @@ -0,0 +1,869 @@ +<!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_33) on Sun Dec 23 14:34:38 SGT 2012 --> +<TITLE> +AbstractTcpClient (Javadocs: oscP5) +</TITLE> + +<META NAME="date" CONTENT="2012-12-23"> + +<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="AbstractTcpClient (Javadocs: oscP5)"; + } +} +</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="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="../netP5/AbstractMulticast.html" title="class in netP5"><B>PREV CLASS</B></A> + <A HREF="../netP5/AbstractTcpServer.html" title="class in netP5"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../index.html?netP5/AbstractTcpClient.html" target="_top"><B>FRAMES</B></A> + <A HREF="AbstractTcpClient.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"> +netP5</FONT> +<BR> +Class AbstractTcpClient</H2> +<PRE> +<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> + <IMG SRC="../resources/inherit.gif" ALT="extended by "><B>netP5.AbstractTcpClient</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</A></DD> +</DL> +<DL> +<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../netP5/TcpClient.html" title="class in netP5">TcpClient</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public abstract class <B>AbstractTcpClient</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</A></DL> +</PRE> + +<P> +<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>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#MODE_NEWLINE">MODE_NEWLINE</A></B></CODE> + +<BR> + terminator is newline.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#MODE_READLINE">MODE_READLINE</A></B></CODE> + +<BR> + terminator is readline.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#MODE_STREAM">MODE_STREAM</A></B></CODE> + +<BR> + no terminator required, packets are sent via + a tcp stream.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#MODE_TERMINATED">MODE_TERMINATED</A></B></CODE> + +<BR> + terminator is terminated, by default this is character '\0' + and can be set with setTerminator</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="../netP5/AbstractTcpClient.html#AbstractTcpClient(netP5.AbstractTcpServer, java.net.Socket, netP5.TcpPacketListener, int, int)">AbstractTcpClient</A></B>(<A HREF="../netP5/AbstractTcpServer.html" title="class in netP5">AbstractTcpServer</A> theTcpServer, + <A HREF="http://java.sun.com/javase/6/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</A> theSocket, + <A HREF="../netP5/TcpPacketListener.html" title="interface in netP5">TcpPacketListener</A> theTcpPacketListener, + int theServerPort, + int theMode)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#AbstractTcpClient(java.lang.String, int)">AbstractTcpClient</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theHost, + int thePort)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#AbstractTcpClient(java.lang.String, int, int)">AbstractTcpClient</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theHost, + int thePort, + int theMode)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#AbstractTcpClient(netP5.TcpPacketListener, java.lang.String, int)">AbstractTcpClient</A></B>(<A HREF="../netP5/TcpPacketListener.html" title="interface in netP5">TcpPacketListener</A> theTcpPacketListener, + <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theHost, + int thePort)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#AbstractTcpClient(netP5.TcpPacketListener, java.lang.String, int, int)">AbstractTcpClient</A></B>(<A HREF="../netP5/TcpPacketListener.html" title="interface in netP5">TcpPacketListener</A> theTcpPacketListener, + <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theHost, + int thePort, + int theMode)</CODE> + +<BR> + </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="../netP5/AbstractTcpClient.html#dispose()">dispose</A></B>()</CODE> + +<BR> + stop and dispose a tcp client.</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="../netP5/AbstractTcpClient.html#equals(netP5.NetAddress)">equals</A></B>(<A HREF="../netP5/NetAddress.html" title="class in netP5">NetAddress</A> theNetAddress)</CODE> + +<BR> + </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="../netP5/AbstractTcpClient.html#equals(netP5.TcpClient)">equals</A></B>(<A HREF="../netP5/TcpClient.html" title="class in netP5">TcpClient</A> theClient)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#getString()">getString</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#getStringBuffer()">getStringBuffer</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>abstract void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#handleInput()">handleInput</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>abstract void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#handleStatus(int)">handleStatus</A></B>(int theIndex)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../netP5/TcpPacketListener.html" title="interface in netP5">TcpPacketListener</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#listener()">listener</A></B>()</CODE> + +<BR> + </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="../netP5/AbstractTcpClient.html#mode()">mode</A></B>()</CODE> + +<BR> + get the mode of the terminator.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../netP5/NetAddress.html" title="class in netP5">NetAddress</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#netaddress()">netaddress</A></B>()</CODE> + +<BR> + <B>Deprecated.</B> <I></I> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../netP5/NetAddress.html" title="class in netP5">NetAddress</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#netAddress()">netAddress</A></B>()</CODE> + +<BR> + </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="../netP5/AbstractTcpClient.html#reconnect()">reconnect</A></B>()</CODE> + +<BR> + when a TCP connection is lost, reconnect to the server with reconnect().</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="../netP5/AbstractTcpClient.html#run()">run</A></B>()</CODE> + +<BR> + </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="../netP5/AbstractTcpClient.html#send(byte[])">send</A></B>(byte[] theBytes)</CODE> + +<BR> + </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="../netP5/AbstractTcpClient.html#send(byte[][])">send</A></B>(byte[][] theBytes)</CODE> + +<BR> + </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="../netP5/AbstractTcpClient.html#send(java.lang.String)">send</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theString)</CODE> + +<BR> + </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="../netP5/AbstractTcpClient.html#serverport()">serverport</A></B>()</CODE> + +<BR> + get the server port.</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="../netP5/AbstractTcpClient.html#setTerminator(char)">setTerminator</A></B>(char theTerminator)</CODE> + +<BR> + to parse an incomming tcp message, a terminator character is required to + determine the end of the message so that it can be parsed and forwarded.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../netP5/AbstractTcpClient.html#socket()">socket</A></B>()</CODE> + +<BR> + get the instance of the socket.</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.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</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="MODE_READLINE"><!-- --></A><H3> +MODE_READLINE</H3> +<PRE> +public static final int <B>MODE_READLINE</B></PRE> +<DL> +<DD>terminator is readline. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#netP5.AbstractTcpClient.MODE_READLINE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="MODE_TERMINATED"><!-- --></A><H3> +MODE_TERMINATED</H3> +<PRE> +public static final int <B>MODE_TERMINATED</B></PRE> +<DL> +<DD>terminator is terminated, by default this is character '\0' + and can be set with setTerminator +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#netP5.AbstractTcpClient.MODE_TERMINATED">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="MODE_NEWLINE"><!-- --></A><H3> +MODE_NEWLINE</H3> +<PRE> +public static final int <B>MODE_NEWLINE</B></PRE> +<DL> +<DD>terminator is newline. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#netP5.AbstractTcpClient.MODE_NEWLINE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="MODE_STREAM"><!-- --></A><H3> +MODE_STREAM</H3> +<PRE> +public static final int <B>MODE_STREAM</B></PRE> +<DL> +<DD>no terminator required, packets are sent via + a tcp stream. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#netP5.AbstractTcpClient.MODE_STREAM">Constant Field Values</A></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="AbstractTcpClient(netP5.TcpPacketListener, java.lang.String, int)"><!-- --></A><H3> +AbstractTcpClient</H3> +<PRE> +public <B>AbstractTcpClient</B>(<A HREF="../netP5/TcpPacketListener.html" title="interface in netP5">TcpPacketListener</A> theTcpPacketListener, + <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theHost, + int thePort)</PRE> +<DL> +<DL> +<DT><B>Parameters:</B><DD><CODE>theTcpPacketListener</CODE> - TcpPacketListener<DD><CODE>theHost</CODE> - String<DD><CODE>thePort</CODE> - int</DL> +</DL> +<HR> + +<A NAME="AbstractTcpClient(java.lang.String, int)"><!-- --></A><H3> +AbstractTcpClient</H3> +<PRE> +public <B>AbstractTcpClient</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theHost, + int thePort)</PRE> +<DL> +<DL> +<DT><B>Parameters:</B><DD><CODE>theHost</CODE> - String<DD><CODE>thePort</CODE> - int</DL> +</DL> +<HR> + +<A NAME="AbstractTcpClient(netP5.TcpPacketListener, java.lang.String, int, int)"><!-- --></A><H3> +AbstractTcpClient</H3> +<PRE> +public <B>AbstractTcpClient</B>(<A HREF="../netP5/TcpPacketListener.html" title="interface in netP5">TcpPacketListener</A> theTcpPacketListener, + <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theHost, + int thePort, + int theMode)</PRE> +<DL> +<DL> +<DT><B>Parameters:</B><DD><CODE>theTcpPacketListener</CODE> - TcpPacketListener<DD><CODE>theHost</CODE> - String<DD><CODE>thePort</CODE> - int<DD><CODE>theMode</CODE> - int</DL> +</DL> +<HR> + +<A NAME="AbstractTcpClient(java.lang.String, int, int)"><!-- --></A><H3> +AbstractTcpClient</H3> +<PRE> +public <B>AbstractTcpClient</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theHost, + int thePort, + int theMode)</PRE> +<DL> +<DL> +<DT><B>Parameters:</B><DD><CODE>theHost</CODE> - String<DD><CODE>thePort</CODE> - int<DD><CODE>theMode</CODE> - int</DL> +</DL> +<HR> + +<A NAME="AbstractTcpClient(netP5.AbstractTcpServer, java.net.Socket, netP5.TcpPacketListener, int, int)"><!-- --></A><H3> +AbstractTcpClient</H3> +<PRE> +public <B>AbstractTcpClient</B>(<A HREF="../netP5/AbstractTcpServer.html" title="class in netP5">AbstractTcpServer</A> theTcpServer, + <A HREF="http://java.sun.com/javase/6/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</A> theSocket, + <A HREF="../netP5/TcpPacketListener.html" title="interface in netP5">TcpPacketListener</A> theTcpPacketListener, + int theServerPort, + int theMode)</PRE> +<DL> +<DL> +<DT><B>Parameters:</B><DD><CODE>theTcpServer</CODE> - AbstractTcpServer<DD><CODE>theSocket</CODE> - Socket<DD><CODE>theTcpPacketListener</CODE> - TcpPacketListener<DD><CODE>theServerPort</CODE> - int<DD><CODE>theMode</CODE> - int</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="reconnect()"><!-- --></A><H3> +reconnect</H3> +<PRE> +public void <B>reconnect</B>()</PRE> +<DL> +<DD>when a TCP connection is lost, reconnect to the server with reconnect(). +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setTerminator(char)"><!-- --></A><H3> +setTerminator</H3> +<PRE> +public void <B>setTerminator</B>(char theTerminator)</PRE> +<DL> +<DD>to parse an incomming tcp message, a terminator character is required to + determine the end of the message so that it can be parsed and forwarded. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theTerminator</CODE> - </DL> +</DD> +</DL> +<HR> + +<A NAME="dispose()"><!-- --></A><H3> +dispose</H3> +<PRE> +public void <B>dispose</B>()</PRE> +<DL> +<DD>stop and dispose a tcp client. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="run()"><!-- --></A><H3> +run</H3> +<PRE> +public void <B>run</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true#run()" title="class or interface in java.lang">run</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="handleInput()"><!-- --></A><H3> +handleInput</H3> +<PRE> +public abstract void <B>handleInput</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="handleStatus(int)"><!-- --></A><H3> +handleStatus</H3> +<PRE> +public abstract void <B>handleStatus</B>(int theIndex)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theIndex</CODE> - </DL> +</DD> +</DL> +<HR> + +<A NAME="listener()"><!-- --></A><H3> +listener</H3> +<PRE> +public <A HREF="../netP5/TcpPacketListener.html" title="interface in netP5">TcpPacketListener</A> <B>listener</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD></DL> +</DD> +</DL> +<HR> + +<A NAME="serverport()"><!-- --></A><H3> +serverport</H3> +<PRE> +public int <B>serverport</B>()</PRE> +<DL> +<DD>get the server port. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD></DL> +</DD> +</DL> +<HR> + +<A NAME="socket()"><!-- --></A><H3> +socket</H3> +<PRE> +public <A HREF="http://java.sun.com/javase/6/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</A> <B>socket</B>()</PRE> +<DL> +<DD>get the instance of the socket. more info at java.net.Socket +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD></DL> +</DD> +</DL> +<HR> + +<A NAME="mode()"><!-- --></A><H3> +mode</H3> +<PRE> +public int <B>mode</B>()</PRE> +<DL> +<DD>get the mode of the terminator. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD></DL> +</DD> +</DL> +<HR> + +<A NAME="getString()"><!-- --></A><H3> +getString</H3> +<PRE> +public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getString</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getStringBuffer()"><!-- --></A><H3> +getStringBuffer</H3> +<PRE> +public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</A> <B>getStringBuffer</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="send(byte[])"><!-- --></A><H3> +send</H3> +<PRE> +public void <B>send</B>(byte[] theBytes)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="send(byte[][])"><!-- --></A><H3> +send</H3> +<PRE> +public void <B>send</B>(byte[][] theBytes)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="send(java.lang.String)"><!-- --></A><H3> +send</H3> +<PRE> +public void <B>send</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theString)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="netAddress()"><!-- --></A><H3> +netAddress</H3> +<PRE> +public <A HREF="../netP5/NetAddress.html" title="class in netP5">NetAddress</A> <B>netAddress</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="netaddress()"><!-- --></A><H3> +netaddress</H3> +<PRE> +public <A HREF="../netP5/NetAddress.html" title="class in netP5">NetAddress</A> <B>netaddress</B>()</PRE> +<DL> +<DD><B>Deprecated.</B> <I></I> +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>NetAddress</DL> +</DD> +</DL> +<HR> + +<A NAME="equals(netP5.NetAddress)"><!-- --></A><H3> +equals</H3> +<PRE> +public boolean <B>equals</B>(<A HREF="../netP5/NetAddress.html" title="class in netP5">NetAddress</A> theNetAddress)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theNetAddress</CODE> - NetAddress +<DT><B>Returns:</B><DD>boolean</DL> +</DD> +</DL> +<HR> + +<A NAME="equals(netP5.TcpClient)"><!-- --></A><H3> +equals</H3> +<PRE> +public boolean <B>equals</B>(<A HREF="../netP5/TcpClient.html" title="class in netP5">TcpClient</A> theClient)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</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="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="../netP5/AbstractMulticast.html" title="class in netP5"><B>PREV CLASS</B></A> + <A HREF="../netP5/AbstractTcpServer.html" title="class in netP5"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../index.html?netP5/AbstractTcpClient.html" target="_top"><B>FRAMES</B></A> + <A HREF="AbstractTcpClient.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> +processing library oscP5 by Andreas Schlegel. (c) 2004-2012 +</BODY> +</HTML> |