ChatClient.html
Warning: This file has been marked up for 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 Tue Feb 08 14:56:10 MST 2000 -->
<TITLE>
Chat Snapin Documentation: Class ChatClient
</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 ID="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="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 ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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="../../../com/novell/Chat/Chat.html"><B>PREV CLASS</B></A>
<A HREF="../../../com/novell/Chat/ChatDialog.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="ChatClient.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | <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>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.novell.Chat</FONT>
<BR>
Class ChatClient</H2>
<PRE>
java.lang.Object
|
+--<B>com.novell.Chat.ChatClient</B>
</PRE>
<HR>
<DL>
<DT>public class <B>ChatClient</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../com/novell/Chat/ChatConnection.html">ChatConnection</A>, <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
<P>
When a user wishes to establish a connection with either another
user or with a chat room, the ChatClient is used. It will attempt to connect
at the specified IP address and Port number. Once a connection is made,
it starts some threads that handle the communications with the server.
<P>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></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="../../../com/novell/Chat/ChatClient.html#FORCE_DIS">FORCE_DIS</A></B></CODE>
<BR>
Connection type that forces the disconnection of a User from a Chat Room</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="../../../com/novell/Chat/ChatClient.html#FORCE_DOWN">FORCE_DOWN</A></B></CODE>
<BR>
Connection type that forces the shutdown of a Chat Room</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="../../../com/novell/Chat/ChatClient.html#NORMAL">NORMAL</A></B></CODE>
<BR>
Connection type that is a normal client connection.</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="../../../com/novell/Chat/ChatClient.html#RECONNECT">RECONNECT</A></B></CODE>
<BR>
Connection type that is a reconnection after a server transfer.</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="../../../com/novell/Chat/ChatClient.html#ChatClient(com.novell.Chat.ChatStatusListener, com.novell.Chat.ChatUser, com.novell.Chat.ChatUser, int)">ChatClient</A></B>(<A HREF="../../../com/novell/Chat/ChatStatusListener.html">ChatStatusListener</A> listener,
<A HREF="../../../com/novell/Chat/ChatUser.html">ChatUser</A> serverInfo,
<A HREF="../../../com/novell/Chat/ChatUser.html">ChatUser</A> userInfo,
int svrPort)</CODE>
<BR>
Constructor</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> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/ChatClient.html#acceptConnection(com.novell.Chat.Communications)">acceptConnection</A></B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> comm)</CODE>
<BR>
ComListener Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#changeServer(java.lang.String)">changeServer</A></B>(java.lang.String fullName)</CODE>
<BR>
ComListener Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#close()">close</A></B>()</CODE>
<BR>
ChatConnection Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#comError(com.novell.Chat.Communications, int, java.lang.String)">comError</A></B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> comm,
int errorCode,
java.lang.String message)</CODE>
<BR>
ComListener Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#comStatus(com.novell.Chat.Communications, java.lang.String)">comStatus</A></B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> comm,
java.lang.String message)</CODE>
<BR>
ComListener Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#connect(int)">connect</A></B>(int type)</CODE>
<BR>
This method will first attempt to open the socket to the specified IP
and 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="../../../com/novell/Chat/ChatClient.html#connect(int, java.lang.String)">connect</A></B>(int type,
java.lang.String key)</CODE>
<BR>
This method will first attempt to open the socket to the specified IP
and 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="../../../com/novell/Chat/ChatClient.html#connectionEstablished(com.novell.Chat.Communications)">connectionEstablished</A></B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> comm)</CODE>
<BR>
ComListener Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#connectionUpdate(com.novell.Chat.Communications)">connectionUpdate</A></B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> con)</CODE>
<BR>
ComListener Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#disconnect()">disconnect</A></B>()</CODE>
<BR>
ChatConnection Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#disconnect(java.lang.String)">disconnect</A></B>(java.lang.String key)</CODE>
<BR>
Called to stop the connection and close the socket with a specific client.</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="../../../com/novell/Chat/ChatClient.html#disconnected(com.novell.Chat.Communications)">disconnected</A></B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> comm)</CODE>
<BR>
ComListener Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#echoData(java.lang.String)">echoData</A></B>(java.lang.String data)</CODE>
<BR>
Raised when a server should echo a message to the other clients.</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="../../../com/novell/Chat/ChatClient.html#getConnectionName()">getConnectionName</A></B>()</CODE>
<BR>
ChatConnection Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#getKey()">getKey</A></B>()</CODE>
<BR>
ChatConnection Interface Implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> com.novell.Chat.ObjectEntry</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/ChatClient.html#getObjectEntry()">getObjectEntry</A></B>()</CODE>
<BR>
ChatConnection Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#getOwnerName()">getOwnerName</A></B>()</CODE>
<BR>
</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="../../../com/novell/Chat/ChatClient.html#getType()">getType</A></B>()</CODE>
<BR>
ChatConnection Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#isConnected()">isConnected</A></B>()</CODE>
<BR>
Used to test if the connection is valid.</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="../../../com/novell/Chat/ChatClient.html#messageReceived(int, java.lang.String, java.lang.String)">messageReceived</A></B>(int colorCode,
java.lang.String name,
java.lang.String message)</CODE>
<BR>
ComListener Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#reConnectionEstablished(com.novell.Chat.Communications, java.lang.String)">reConnectionEstablished</A></B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> comm,
java.lang.String oldKey)</CODE>
<BR>
Called when a valid connection has been established.</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="../../../com/novell/Chat/ChatClient.html#sendMessage(java.lang.String)">sendMessage</A></B>(java.lang.String message)</CODE>
<BR>
ChatConnection Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#serverTransferRequest(int)">serverTransferRequest</A></B>(int startColor)</CODE>
<BR>
ComListener Interface Implementation.</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="../../../com/novell/Chat/ChatClient.html#serverTransferResponse(boolean)">serverTransferResponse</A></B>(boolean accepted)</CODE>
<BR>
Raised when a response is received to transfer the server.</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="../../../com/novell/Chat/ChatClient.html#verifyConnection(java.lang.String, java.lang.String)">verifyConnection</A></B>(java.lang.String fullName,
java.lang.String ipAddress)</CODE>
<BR>
ComListener Interface Implementation.</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 =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="NORMAL"><!-- --></A><H3>
NORMAL</H3>
<PRE>
public static final int <B>NORMAL</B></PRE>
<DL>
<DD>Connection type that is a normal client connection.</DL>
<HR>
<A NAME="RECONNECT"><!-- --></A><H3>
RECONNECT</H3>
<PRE>
public static final int <B>RECONNECT</B></PRE>
<DL>
<DD>Connection type that is a reconnection after a server transfer.</DL>
<HR>
<A NAME="FORCE_DOWN"><!-- --></A><H3>
FORCE_DOWN</H3>
<PRE>
public static final int <B>FORCE_DOWN</B></PRE>
<DL>
<DD>Connection type that forces the shutdown of a Chat Room</DL>
<HR>
<A NAME="FORCE_DIS"><!-- --></A><H3>
FORCE_DIS</H3>
<PRE>
public static final int <B>FORCE_DIS</B></PRE>
<DL>
<DD>Connection type that forces the disconnection of a User from a Chat Room</DL>
<!-- ========= 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="ChatClient(com.novell.Chat.ChatStatusListener, com.novell.Chat.ChatUser, com.novell.Chat.ChatUser, int)"><!-- --></A><H3>
ChatClient</H3>
<PRE>
public <B>ChatClient</B>(<A HREF="../../../com/novell/Chat/ChatStatusListener.html">ChatStatusListener</A> listener,
<A HREF="../../../com/novell/Chat/ChatUser.html">ChatUser</A> serverInfo,
<A HREF="../../../com/novell/Chat/ChatUser.html">ChatUser</A> userInfo,
int svrPort)</PRE>
<DL>
<DD>Constructor<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - The ChatStatusListener that receives the Chat information from this class.<DD><CODE>serverInfo</CODE> - Information about the server the client is connected to.<DD><CODE>chatUser</CODE> - Information about the user using this client.<DD><CODE>svrPort</CODE> - The port number to connect at.</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="getKey()"><!-- --></A><H3>
getKey</H3>
<PRE>
public java.lang.String <B>getKey</B>()</PRE>
<DL>
<DD>ChatConnection Interface Implementation.
This key can be used as a unique reference string for this connection.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ChatConnection.html#getKey()">getKey</A> in interface <A HREF="../../../com/novell/Chat/ChatConnection.html">ChatConnection</A></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A string in the form of IP:Port</DL>
</DD>
</DL>
<HR>
<A NAME="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
public java.lang.String <B>getType</B>()</PRE>
<DL>
<DD>ChatConnection Interface Implementation.
Gets the type of object this client is communicating with:
User or Chat Room.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ChatConnection.html#getType()">getType</A> in interface <A HREF="../../../com/novell/Chat/ChatConnection.html">ChatConnection</A></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The ObjectType name.</DL>
</DD>
</DL>
<HR>
<A NAME="getObjectEntry()"><!-- --></A><H3>
getObjectEntry</H3>
<PRE>
public com.novell.Chat.ObjectEntry <B>getObjectEntry</B>()</PRE>
<DL>
<DD>ChatConnection Interface Implementation.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ChatConnection.html#getObjectEntry()">getObjectEntry</A> in interface <A HREF="../../../com/novell/Chat/ChatConnection.html">ChatConnection</A></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The ObjectEntry this server is associated with.</DL>
</DD>
</DL>
<HR>
<A NAME="sendMessage(java.lang.String)"><!-- --></A><H3>
sendMessage</H3>
<PRE>
public void <B>sendMessage</B>(java.lang.String message)</PRE>
<DL>
<DD>ChatConnection Interface Implementation.
Sends a formatted message from the client to the server.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ChatConnection.html#sendMessage(java.lang.String)">sendMessage</A> in interface <A HREF="../../../com/novell/Chat/ChatConnection.html">ChatConnection</A></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - The message being sent.</DL>
</DD>
</DL>
<HR>
<A NAME="connect(int)"><!-- --></A><H3>
connect</H3>
<PRE>
public void <B>connect</B>(int type)</PRE>
<DL>
<DD>This method will first attempt to open the socket to the specified IP
and port. If it fails, it will increment the port by one and then try
again. The reason for this is that the server my not have been able to
listen at the specifed port due to a port conflict, so the server will
also increment the port by one until it can find a valid port. The
expectation is that this client will eventually find the port the server was
able to open. It is rare that this will be need, but it's a back up just in case.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of connection to make.</DL>
</DD>
</DL>
<HR>
<A NAME="connect(int, java.lang.String)"><!-- --></A><H3>
connect</H3>
<PRE>
public void <B>connect</B>(int type,
java.lang.String key)</PRE>
<DL>
<DD>This method will first attempt to open the socket to the specified IP
and port. If it fails, it will increment the port by one and then try
again. The reason for this is that the server my not have been able to
listen at the specifed port due to a port conflict, so the server will
also increment the port by one until it can find a valid port. The
expectation is that this client will eventually find the port the server was
able to open. It is rare that this will be need, but it's a back up just in case.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of connection to make.<DD><CODE>key</CODE> - The key previously used by this client.
Only used for RECONNECT and FORCEDOWN types.</DL>
</DD>
</DL>
<HR>
<A NAME="getConnectionName()"><!-- --></A><H3>
getConnectionName</H3>
<PRE>
public java.lang.String <B>getConnectionName</B>()</PRE>
<DL>
<DD>ChatConnection Interface Implementation.
Gets the name of the person or chat room this session is with.
Used in the title of the ChatDialog.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ChatConnection.html#getConnectionName()">getConnectionName</A> in interface <A HREF="../../../com/novell/Chat/ChatConnection.html">ChatConnection</A></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The name to place in the title.</DL>
</DD>
</DL>
<HR>
<A NAME="disconnect()"><!-- --></A><H3>
disconnect</H3>
<PRE>
public void <B>disconnect</B>()</PRE>
<DL>
<DD>ChatConnection Interface Implementation.
ComListener Interface Implementation.
Called to stop the connection and close the socket.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ChatConnection.html#disconnect()">disconnect</A> in interface <A HREF="../../../com/novell/Chat/ChatConnection.html">ChatConnection</A></DL>
</DD>
</DL>
<HR>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()</PRE>
<DL>
<DD>ChatConnection Interface Implementation.
ComListener Interface Implementation.
Shuts down the client.
This should be called on shut down.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ChatConnection.html#close()">close</A> in interface <A HREF="../../../com/novell/Chat/ChatConnection.html">ChatConnection</A></DL>
</DD>
</DL>
<HR>
<A NAME="isConnected()"><!-- --></A><H3>
isConnected</H3>
<PRE>
public boolean <B>isConnected</B>()</PRE>
<DL>
<DD>Used to test if the connection is valid.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>True if there is a connection.</DL>
</DD>
</DL>
<HR>
<A NAME="messageReceived(int, java.lang.String, java.lang.String)"><!-- --></A><H3>
messageReceived</H3>
<PRE>
public void <B>messageReceived</B>(int colorCode,
java.lang.String name,
java.lang.String message)</PRE>
<DL>
<DD>ComListener Interface Implementation.
Called when a message is received.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#messageReceived(int, java.lang.String, java.lang.String)">messageReceived</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>colorCode</CODE> - The code of the color to use for the name.<DD><CODE>name</CODE> - The name of the user who sent the message.<DD><CODE>message</CODE> - The message received.</DL>
</DD>
</DL>
<HR>
<A NAME="connectionEstablished(com.novell.Chat.Communications)"><!-- --></A><H3>
connectionEstablished</H3>
<PRE>
public void <B>connectionEstablished</B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> comm)</PRE>
<DL>
<DD>ComListener Interface Implementation.
Called when a valid connection has been established.
Once this event is raised, you can assume that the connection
is valid and has been approved by both sides.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#connectionEstablished(com.novell.Chat.Communications)">connectionEstablished</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>comm</CODE> - Reference to the Communications object that is handling the
the connection.</DL>
</DD>
</DL>
<HR>
<A NAME="comError(com.novell.Chat.Communications, int, java.lang.String)"><!-- --></A><H3>
comError</H3>
<PRE>
public void <B>comError</B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> comm,
int errorCode,
java.lang.String message)</PRE>
<DL>
<DD>ComListener Interface Implementation.
Informs the listener of errors that occur in the connection.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#comError(com.novell.Chat.Communications, int, java.lang.String)">comError</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>comm</CODE> - Reference to the connection.<DD><CODE>errorCode</CODE> - The error code constant.<DD><CODE>message</CODE> - The error message.</DL>
</DD>
</DL>
<HR>
<A NAME="comStatus(com.novell.Chat.Communications, java.lang.String)"><!-- --></A><H3>
comStatus</H3>
<PRE>
public void <B>comStatus</B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> comm,
java.lang.String message)</PRE>
<DL>
<DD>ComListener Interface Implementation.
Informs the listener of the current status of the connection.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#comStatus(com.novell.Chat.Communications, java.lang.String)">comStatus</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>comm</CODE> - Reference to the connection.<DD><CODE>message</CODE> - The status message.</DL>
</DD>
</DL>
<HR>
<A NAME="verifyConnection(java.lang.String, java.lang.String)"><!-- --></A><H3>
verifyConnection</H3>
<PRE>
public boolean <B>verifyConnection</B>(java.lang.String fullName,
java.lang.String ipAddress)</PRE>
<DL>
<DD>ComListener Interface Implementation.
Requests the listener to verify the connection by checking the
user's full name against the ipAddress.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#verifyConnection(java.lang.String, java.lang.String)">verifyConnection</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fullName</CODE> - The fullName of the user to check.<DD><CODE>ipAddress</CODE> - The supposed IP Address of the user.<DT><B>Returns:</B><DD>True if it verifies correctly.</DL>
</DD>
</DL>
<HR>
<A NAME="acceptConnection(com.novell.Chat.Communications)"><!-- --></A><H3>
acceptConnection</H3>
<PRE>
public int <B>acceptConnection</B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> comm)</PRE>
<DL>
<DD>ComListener Interface Implementation.
Asks the listener if it accepts or rejects the connection.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#acceptConnection(com.novell.Chat.Communications)">acceptConnection</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>comm</CODE> - Reference to the connection.<DT><B>Returns:</B><DD>True if it accepts.</DL>
</DD>
</DL>
<HR>
<A NAME="disconnected(com.novell.Chat.Communications)"><!-- --></A><H3>
disconnected</H3>
<PRE>
public void <B>disconnected</B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> comm)</PRE>
<DL>
<DD>ComListener Interface Implementation.
Called when the given connection is lost.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#disconnected(com.novell.Chat.Communications)">disconnected</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>comm</CODE> - Reference to the connection.</DL>
</DD>
</DL>
<HR>
<A NAME="connectionUpdate(com.novell.Chat.Communications)"><!-- --></A><H3>
connectionUpdate</H3>
<PRE>
public void <B>connectionUpdate</B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> con)</PRE>
<DL>
<DD>ComListener Interface Implementation.
This is called when a user enters or leaves a chat room.
It is a request to update your user lists.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#connectionUpdate(com.novell.Chat.Communications)">connectionUpdate</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>comm</CODE> - Reference to the connection.</DL>
</DD>
</DL>
<HR>
<A NAME="serverTransferRequest(int)"><!-- --></A><H3>
serverTransferRequest</H3>
<PRE>
public boolean <B>serverTransferRequest</B>(int startColor)</PRE>
<DL>
<DD>ComListener Interface Implementation.
Raised when a request to transfer the server to this user to received.
Used only by Clients.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#serverTransferRequest(int)">serverTransferRequest</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>startColor</CODE> - The color to start giving to new users for their user name.<DT><B>Returns:</B><DD>True if successfull.</DL>
</DD>
</DL>
<HR>
<A NAME="changeServer(java.lang.String)"><!-- --></A><H3>
changeServer</H3>
<PRE>
public void <B>changeServer</B>(java.lang.String fullName)</PRE>
<DL>
<DD>ComListener Interface Implementation.
Raised when a client must change which server it is connected to.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#changeServer(java.lang.String)">changeServer</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fullName</CODE> - The fullname of the Chat Room.</DL>
</DD>
</DL>
<HR>
<A NAME="echoData(java.lang.String)"><!-- --></A><H3>
echoData</H3>
<PRE>
public boolean <B>echoData</B>(java.lang.String data)</PRE>
<DL>
<DD><B>Description copied from interface: <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></B></DD>
<DD>Raised when a server should echo a message to the other clients.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#echoData(java.lang.String)">echoData</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><B>Tags copied from interface: <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></B></DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - The message to echo.</DL>
</DD>
</DL>
<HR>
<A NAME="getOwnerName()"><!-- --></A><H3>
getOwnerName</H3>
<PRE>
public java.lang.String <B>getOwnerName</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#getOwnerName()">getOwnerName</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><B>Tags copied from interface: <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></B></DD>
<DD><DL>
<DT><B>Returns:</B><DD>The owners name of the Chat Room.</DL>
</DD>
</DL>
<HR>
<A NAME="disconnect(java.lang.String)"><!-- --></A><H3>
disconnect</H3>
<PRE>
public void <B>disconnect</B>(java.lang.String key)</PRE>
<DL>
<DD><B>Description copied from interface: <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></B></DD>
<DD>Called to stop the connection and close the socket with a specific client.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#disconnect(java.lang.String)">disconnect</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><B>Tags copied from interface: <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></B></DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - The (IP:Port) key of the client to disconnect.</DL>
</DD>
</DL>
<HR>
<A NAME="serverTransferResponse(boolean)"><!-- --></A><H3>
serverTransferResponse</H3>
<PRE>
public void <B>serverTransferResponse</B>(boolean accepted)</PRE>
<DL>
<DD><B>Description copied from interface: <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></B></DD>
<DD>Raised when a response is received to transfer the server.
Used only by Servers.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#serverTransferResponse(boolean)">serverTransferResponse</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><B>Tags copied from interface: <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></B></DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>accepted</CODE> - True if the request was accepted.</DL>
</DD>
</DL>
<HR>
<A NAME="reConnectionEstablished(com.novell.Chat.Communications, java.lang.String)"><!-- --></A><H3>
reConnectionEstablished</H3>
<PRE>
public void <B>reConnectionEstablished</B>(<A HREF="../../../com/novell/Chat/Communications.html">Communications</A> comm,
java.lang.String oldKey)</PRE>
<DL>
<DD><B>Description copied from interface: <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></B></DD>
<DD>Called when a valid connection has been established.
Once this event is raised, you can assume that the connection
is valid and has been approved by both sides.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../com/novell/Chat/ComListener.html#reConnectionEstablished(com.novell.Chat.Communications, java.lang.String)">reConnectionEstablished</A> in interface <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></DL>
</DD>
<DD><B>Tags copied from interface: <A HREF="../../../com/novell/Chat/ComListener.html">ComListener</A></B></DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>comm</CODE> - Reference to the Communications object that is handling the
the connection.</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 ID="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="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 ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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="../../../com/novell/Chat/Chat.html"><B>PREV CLASS</B></A>
<A HREF="../../../com/novell/Chat/ChatDialog.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="ChatClient.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | <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>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>