diff options
Diffstat (limited to 'VS-Sim-Javadoc/protocols/VSAbstractProtocol.html')
| -rw-r--r-- | VS-Sim-Javadoc/protocols/VSAbstractProtocol.html | 1019 |
1 files changed, 1019 insertions, 0 deletions
diff --git a/VS-Sim-Javadoc/protocols/VSAbstractProtocol.html b/VS-Sim-Javadoc/protocols/VSAbstractProtocol.html new file mode 100644 index 0000000..d39f021 --- /dev/null +++ b/VS-Sim-Javadoc/protocols/VSAbstractProtocol.html @@ -0,0 +1,1019 @@ +<!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_03-p4) on Thu Aug 14 07:45:24 GMT 2008 --> +<TITLE> +VSAbstractProtocol +</TITLE> + +<META NAME="date" CONTENT="2008-08-14"> + +<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="VSAbstractProtocol"; + } +} +</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"> + PREV CLASS + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../index.html?protocols/VSAbstractProtocol.html" target="_top"><B>FRAMES</B></A> + <A HREF="VSAbstractProtocol.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"> +protocols</FONT> +<BR> +Class VSAbstractProtocol</H2> +<PRE> +java.lang.Object + <IMG SRC="../resources/inherit.gif" ALT="extended by "><A HREF="../prefs/VSPrefs.html" title="class in prefs">prefs.VSPrefs</A> + <IMG SRC="../resources/inherit.gif" ALT="extended by "><A HREF="../prefs/VSSerializablePrefs.html" title="class in prefs">prefs.VSSerializablePrefs</A> + <IMG SRC="../resources/inherit.gif" ALT="extended by "><A HREF="../events/VSAbstractEvent.html" title="class in events">events.VSAbstractEvent</A> + <IMG SRC="../resources/inherit.gif" ALT="extended by "><B>protocols.VSAbstractProtocol</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../serialize/VSSerializable.html" title="interface in serialize">VSSerializable</A></DD> +</DL> +<DL> +<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../protocols/implementations/VSBasicMulticastProtocol.html" title="class in protocols.implementations">VSBasicMulticastProtocol</A>, <A HREF="../protocols/implementations/VSBerkelyTimeProtocol.html" title="class in protocols.implementations">VSBerkelyTimeProtocol</A>, <A HREF="../protocols/implementations/VSBroadcastProtocol.html" title="class in protocols.implementations">VSBroadcastProtocol</A>, <A HREF="../protocols/implementations/VSDummyProtocol.html" title="class in protocols.implementations">VSDummyProtocol</A>, <A HREF="../protocols/implementations/VSExternalTimeSyncProtocol.html" title="class in protocols.implementations">VSExternalTimeSyncProtocol</A>, <A HREF="../protocols/implementations/VSInternalTimeSyncProtocol.html" title="class in protocols.implementations">VSInternalTimeSyncProtocol</A>, <A HREF="../protocols/implementations/VSOnePhaseCommitProtocol.html" title="class in protocols.implementations">VSOnePhaseCommitProtocol</A>, <A HREF="../protocols/implementations/VSPingPongProtocol.html" title="class in protocols.implementations">VSPingPongProtocol</A>, <A HREF="../protocols/implementations/VSReliableMulticastProtocol.html" title="class in protocols.implementations">VSReliableMulticastProtocol</A>, <A HREF="../protocols/implementations/VSTwoPhaseCommitProtocol.html" title="class in protocols.implementations">VSTwoPhaseCommitProtocol</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public abstract class <B>VSAbstractProtocol</B><DT>extends <A HREF="../events/VSAbstractEvent.html" title="class in events">VSAbstractEvent</A></DL> +</PRE> + +<P> +The class VSAbstractProtocol, this class defined the basic framework of a + protocol. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Paul C. Buetow</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 static boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../protocols/VSAbstractProtocol.html#HAS_ON_CLIENT_START">HAS_ON_CLIENT_START</A></B></CODE> + +<BR> + The protocol has an onClientStart method</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected static boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../protocols/VSAbstractProtocol.html#HAS_ON_SERVER_START">HAS_ON_SERVER_START</A></B></CODE> + +<BR> + The protocol has an onServerStart method</TD> +</TR> +</TABLE> + <A NAME="fields_inherited_from_class_events.VSAbstractEvent"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Fields inherited from class events.<A HREF="../events/VSAbstractEvent.html" title="class in events">VSAbstractEvent</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../events/VSAbstractEvent.html#prefs">prefs</A>, <A HREF="../events/VSAbstractEvent.html#process">process</A></CODE></TD> +</TR> +</TABLE> + <A NAME="fields_inherited_from_class_prefs.VSPrefs"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Fields inherited from class prefs.<A HREF="../prefs/VSPrefs.html" title="class in prefs">VSPrefs</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../prefs/VSPrefs.html#BOOLEAN_PREFIX">BOOLEAN_PREFIX</A>, <A HREF="../prefs/VSPrefs.html#COLOR_PREFIX">COLOR_PREFIX</A>, <A HREF="../prefs/VSPrefs.html#FLOAT_PREFIX">FLOAT_PREFIX</A>, <A HREF="../prefs/VSPrefs.html#id">id</A>, <A HREF="../prefs/VSPrefs.html#INTEGER_PREFIX">INTEGER_PREFIX</A>, <A HREF="../prefs/VSPrefs.html#LONG_PREFIX">LONG_PREFIX</A>, <A HREF="../prefs/VSPrefs.html#STRING_PREFIX">STRING_PREFIX</A>, <A HREF="../prefs/VSPrefs.html#VECTOR_PREFIX">VECTOR_PREFIX</A></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="../protocols/VSAbstractProtocol.html#VSAbstractProtocol(boolean)">VSAbstractProtocol</A></B>(boolean hasOnServerStart)</CODE> + +<BR> + A simple constructor.</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="../protocols/VSAbstractProtocol.html#currentContextIsServer(boolean)">currentContextIsServer</A></B>(boolean currentContextIsServer)</CODE> + +<BR> + Sets if the current context is 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="../protocols/VSAbstractProtocol.html#deserialize(serialize.VSSerialize, java.io.ObjectInputStream)">deserialize</A></B>(<A HREF="../serialize/VSSerialize.html" title="class in serialize">VSSerialize</A> serialize, + java.io.ObjectInputStream objectInputStream)</CODE> + +<BR> + Deserializes</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="../protocols/VSAbstractProtocol.html#getNumProcesses()">getNumProcesses</A></B>()</CODE> + +<BR> + Gets the num processes.</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="../protocols/VSAbstractProtocol.html#hasOnServerStart()">hasOnServerStart</A></B>()</CODE> + +<BR> + Checks how the protocol will start</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="../protocols/VSAbstractProtocol.html#isClient()">isClient</A></B>()</CODE> + +<BR> + Checks if is 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="../protocols/VSAbstractProtocol.html#isClient(boolean)">isClient</A></B>(boolean isClient)</CODE> + +<BR> + Sets if is 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="../protocols/VSAbstractProtocol.html#isRelevantMessage(core.VSMessage)">isRelevantMessage</A></B>(<A HREF="../core/VSMessage.html" title="class in core">VSMessage</A> message)</CODE> + +<BR> + Check's if its a relevant message.</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="../protocols/VSAbstractProtocol.html#isServer()">isServer</A></B>()</CODE> + +<BR> + Checks if is 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="../protocols/VSAbstractProtocol.html#isServer(boolean)">isServer</A></B>(boolean isServer)</CODE> + +<BR> + Sets if is server.</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="../protocols/VSAbstractProtocol.html#onClientInit()">onClientInit</A></B>()</CODE> + +<BR> + On client init.</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="../protocols/VSAbstractProtocol.html#onClientRecv(core.VSMessage)">onClientRecv</A></B>(<A HREF="../core/VSMessage.html" title="class in core">VSMessage</A> message)</CODE> + +<BR> + On client recv.</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="../protocols/VSAbstractProtocol.html#onClientReset()">onClientReset</A></B>()</CODE> + +<BR> + On client reset.</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="../protocols/VSAbstractProtocol.html#onClientSchedule()">onClientSchedule</A></B>()</CODE> + +<BR> + On client schedule.</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="../protocols/VSAbstractProtocol.html#onClientScheduleStart()">onClientScheduleStart</A></B>()</CODE> + +<BR> + Runs a client schedule</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="../protocols/VSAbstractProtocol.html#onClientStart()">onClientStart</A></B>()</CODE> + +<BR> + On client start.</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="../protocols/VSAbstractProtocol.html#onInit()">onInit</A></B>()</CODE> + +<BR> + Every event has its own initialize method.</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="../protocols/VSAbstractProtocol.html#onMessageRecvStart(core.VSMessage)">onMessageRecvStart</A></B>(<A HREF="../core/VSMessage.html" title="class in core">VSMessage</A> message)</CODE> + +<BR> + On message recv.</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="../protocols/VSAbstractProtocol.html#onServerInit()">onServerInit</A></B>()</CODE> + +<BR> + On server init.</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="../protocols/VSAbstractProtocol.html#onServerRecv(core.VSMessage)">onServerRecv</A></B>(<A HREF="../core/VSMessage.html" title="class in core">VSMessage</A> message)</CODE> + +<BR> + On server recv.</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="../protocols/VSAbstractProtocol.html#onServerReset()">onServerReset</A></B>()</CODE> + +<BR> + On server reset.</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="../protocols/VSAbstractProtocol.html#onServerSchedule()">onServerSchedule</A></B>()</CODE> + +<BR> + On server schedule.</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="../protocols/VSAbstractProtocol.html#onServerScheduleStart()">onServerScheduleStart</A></B>()</CODE> + +<BR> + Runs a server schedule</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="../protocols/VSAbstractProtocol.html#onServerStart()">onServerStart</A></B>()</CODE> + +<BR> + On server start.</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="../protocols/VSAbstractProtocol.html#onStart()">onStart</A></B>()</CODE> + +<BR> + Every event can get started.</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="../protocols/VSAbstractProtocol.html#removeSchedules()">removeSchedules</A></B>()</CODE> + +<BR> + Removes all schedules of the protocol (server or 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="../protocols/VSAbstractProtocol.html#reset()">reset</A></B>()</CODE> + +<BR> + Resets the protocol.</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="../protocols/VSAbstractProtocol.html#scheduleAt(long)">scheduleAt</A></B>(long time)</CODE> + +<BR> + Reschedules the protocol for a new time and runs onClientSchedule or + onServerSchedule</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="../protocols/VSAbstractProtocol.html#sendMessage(core.VSMessage)">sendMessage</A></B>(<A HREF="../core/VSMessage.html" title="class in core">VSMessage</A> message)</CODE> + +<BR> + Sends a message.</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="../protocols/VSAbstractProtocol.html#serialize(serialize.VSSerialize, java.io.ObjectOutputStream)">serialize</A></B>(<A HREF="../serialize/VSSerialize.html" title="class in serialize">VSSerialize</A> serialize, + java.io.ObjectOutputStream objectOutputStream)</CODE> + +<BR> + Serializes</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="../protocols/VSAbstractProtocol.html#toString()">toString</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_events.VSAbstractEvent"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class events.<A HREF="../events/VSAbstractEvent.html" title="class in events">VSAbstractEvent</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../events/VSAbstractEvent.html#equals(events.VSAbstractEvent)">equals</A>, <A HREF="../events/VSAbstractEvent.html#getClassname()">getClassname</A>, <A HREF="../events/VSAbstractEvent.html#getCopy()">getCopy</A>, <A HREF="../events/VSAbstractEvent.html#getCopy(core.VSInternalProcess)">getCopy</A>, <A HREF="../events/VSAbstractEvent.html#getName()">getName</A>, <A HREF="../events/VSAbstractEvent.html#getProcess()">getProcess</A>, <A HREF="../events/VSAbstractEvent.html#getShortname()">getShortname</A>, <A HREF="../events/VSAbstractEvent.html#init()">init</A>, <A HREF="../events/VSAbstractEvent.html#init(core.VSInternalProcess)">init</A>, <A HREF="../events/VSAbstractEvent.html#log(java.lang.String)">log</A>, <A HREF="../events/VSAbstractEvent.html#setClassname(java.lang.String)">setClassname</A>, <A HREF="../events/VSAbstractEvent.html#setShortname(java.lang.String)">setShortname</A></CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_prefs.VSPrefs"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class prefs.<A HREF="../prefs/VSPrefs.html" title="class in prefs">VSPrefs</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../prefs/VSPrefs.html#clear()">clear</A>, <A HREF="../prefs/VSPrefs.html#copyBooleans(prefs.VSPrefs, java.lang.String[])">copyBooleans</A>, <A HREF="../prefs/VSPrefs.html#copyColors(prefs.VSPrefs, java.lang.String[])">copyColors</A>, <A HREF="../prefs/VSPrefs.html#copyFloats(prefs.VSPrefs, java.lang.String[])">copyFloats</A>, <A HREF="../prefs/VSPrefs.html#copyIntegers(prefs.VSPrefs, java.lang.String[])">copyIntegers</A>, <A HREF="../prefs/VSPrefs.html#copyLongs(prefs.VSPrefs, java.lang.String[])">copyLongs</A>, <A HREF="../prefs/VSPrefs.html#copyStrings(prefs.VSPrefs, java.lang.String[])">copyStrings</A>, <A HREF="../prefs/VSPrefs.html#deserialize_(serialize.VSSerialize, java.io.ObjectInputStream)">deserialize_</A>, <A HREF="../prefs/VSPrefs.html#getAllFullKeys()">getAllFullKeys</A>, <A HREF="../prefs/VSPrefs.html#getBoolean(java.lang.String)">getBoolean</A>, <A HREF="../prefs/VSPrefs.html#getBooleanKeySet()">getBooleanKeySet</A>, <A HREF="../prefs/VSPrefs.html#getBooleanObj(java.lang.String)">getBooleanObj</A>, <A HREF="../prefs/VSPrefs.html#getColor(java.lang.String)">getColor</A>, <A HREF="../prefs/VSPrefs.html#getColorKeySet()">getColorKeySet</A>, <A HREF="../prefs/VSPrefs.html#getDescription(java.lang.String)">getDescription</A>, <A HREF="../prefs/VSPrefs.html#getFloat(java.lang.String)">getFloat</A>, <A HREF="../prefs/VSPrefs.html#getFloatKeySet()">getFloatKeySet</A>, <A HREF="../prefs/VSPrefs.html#getFloatObj(java.lang.String)">getFloatObj</A>, <A HREF="../prefs/VSPrefs.html#getID()">getID</A>, <A HREF="../prefs/VSPrefs.html#getInteger(java.lang.String)">getInteger</A>, <A HREF="../prefs/VSPrefs.html#getIntegerKeySet()">getIntegerKeySet</A>, <A HREF="../prefs/VSPrefs.html#getIntegerObj(java.lang.String)">getIntegerObj</A>, <A HREF="../prefs/VSPrefs.html#getLong(java.lang.String)">getLong</A>, <A HREF="../prefs/VSPrefs.html#getLongKeySet()">getLongKeySet</A>, <A HREF="../prefs/VSPrefs.html#getLongObj(java.lang.String)">getLongObj</A>, <A HREF="../prefs/VSPrefs.html#getObject(java.lang.String)">getObject</A>, <A HREF="../prefs/VSPrefs.html#getRestriction(java.lang.String)">getRestriction</A>, <A HREF="../prefs/VSPrefs.html#getString(java.lang.String)">getString</A>, <A HREF="../prefs/VSPrefs.html#getStringKeySet()">getStringKeySet</A>, <A HREF="../prefs/VSPrefs.html#getUnit(java.lang.String)">getUnit</A>, <A HREF="../prefs/VSPrefs.html#getVector(java.lang.String)">getVector</A>, <A HREF="../prefs/VSPrefs.html#getVectorKeySet()">getVectorKeySet</A>, <A HREF="../prefs/VSPrefs.html#initBoolean(java.lang.String, boolean)">initBoolean</A>, <A HREF="../prefs/VSPrefs.html#initBoolean(java.lang.String, java.lang.Boolean)">initBoolean</A>, <A HREF="../prefs/VSPrefs.html#initBoolean(java.lang.String, boolean, java.lang.String)">initBoolean</A>, <A HREF="../prefs/VSPrefs.html#initColor(java.lang.String, java.awt.Color)">initColor</A>, <A HREF="../prefs/VSPrefs.html#initColor(java.lang.String, java.awt.Color, java.lang.String)">initColor</A>, <A HREF="../prefs/VSPrefs.html#initDescription(java.lang.String, java.lang.String)">initDescription</A>, <A HREF="../prefs/VSPrefs.html#initFloat(java.lang.String, float)">initFloat</A>, <A HREF="../prefs/VSPrefs.html#initFloat(java.lang.String, java.lang.Float)">initFloat</A>, <A HREF="../prefs/VSPrefs.html#initFloat(java.lang.String, float, java.lang.String)">initFloat</A>, <A HREF="../prefs/VSPrefs.html#initFloat(java.lang.String, float, java.lang.String, java.lang.String)">initFloat</A>, <A HREF="../prefs/VSPrefs.html#initInteger(java.lang.String, int)">initInteger</A>, <A HREF="../prefs/VSPrefs.html#initInteger(java.lang.String, int, java.lang.String)">initInteger</A>, <A HREF="../prefs/VSPrefs.html#initInteger(java.lang.String, int, java.lang.String, int, int)">initInteger</A>, <A HREF="../prefs/VSPrefs.html#initInteger(java.lang.String, int, java.lang.String, int, int, java.lang.String)">initInteger</A>, <A HREF="../prefs/VSPrefs.html#initInteger(java.lang.String, int, java.lang.String, prefs.VSPrefsRestriction.VSIntegerPrefsRestriction)">initInteger</A>, <A HREF="../prefs/VSPrefs.html#initInteger(java.lang.String, int, java.lang.String, prefs.VSPrefsRestriction.VSIntegerPrefsRestriction, java.lang.String)">initInteger</A>, <A HREF="../prefs/VSPrefs.html#initLong(java.lang.String, long)">initLong</A>, <A HREF="../prefs/VSPrefs.html#initLong(java.lang.String, java.lang.Long)">initLong</A>, <A HREF="../prefs/VSPrefs.html#initLong(java.lang.String, long, java.lang.String)">initLong</A>, <A HREF="../prefs/VSPrefs.html#initLong(java.lang.String, long, java.lang.String, java.lang.String)">initLong</A>, <A HREF="../prefs/VSPrefs.html#initRestriction(java.lang.String, prefs.VSPrefsRestriction)">initRestriction</A>, <A HREF="../prefs/VSPrefs.html#initString(java.lang.String, java.lang.String)">initString</A>, <A HREF="../prefs/VSPrefs.html#initString(java.lang.String, java.lang.String, java.lang.String)">initString</A>, <A HREF="../prefs/VSPrefs.html#initUnit(java.lang.String, java.lang.String)">initUnit</A>, <A HREF="../prefs/VSPrefs.html#initVector(java.lang.String, java.util.Vector)">initVector</A>, <A HREF="../prefs/VSPrefs.html#initVector(java.lang.String, java.util.Vector, java.lang.String)">initVector</A>, <A HREF="../prefs/VSPrefs.html#initVector(java.lang.String, java.util.Vector, java.lang.String, java.lang.String)">initVector</A>, <A HREF="../prefs/VSPrefs.html#isEmpty()">isEmpty</A>, <A HREF="../prefs/VSPrefs.html#objectExists(java.lang.String)">objectExists</A>, <A HREF="../prefs/VSPrefs.html#removeObject(java.lang.String)">removeObject</A>, <A HREF="../prefs/VSPrefs.html#serialize_(serialize.VSSerialize, java.io.ObjectOutputStream)">serialize_</A>, <A HREF="../prefs/VSPrefs.html#setBoolean(java.lang.String, boolean)">setBoolean</A>, <A HREF="../prefs/VSPrefs.html#setBoolean(java.lang.String, java.lang.Boolean)">setBoolean</A>, <A HREF="../prefs/VSPrefs.html#setColor(java.lang.String, java.awt.Color)">setColor</A>, <A HREF="../prefs/VSPrefs.html#setFloat(java.lang.String, float)">setFloat</A>, <A HREF="../prefs/VSPrefs.html#setFloat(java.lang.String, java.lang.Float)">setFloat</A>, <A HREF="../prefs/VSPrefs.html#setInteger(java.lang.String, int)">setInteger</A>, <A HREF="../prefs/VSPrefs.html#setInteger(java.lang.String, java.lang.Integer)">setInteger</A>, <A HREF="../prefs/VSPrefs.html#setLong(java.lang.String, long)">setLong</A>, <A HREF="../prefs/VSPrefs.html#setLong(java.lang.String, java.lang.Long)">setLong</A>, <A HREF="../prefs/VSPrefs.html#setObject(java.lang.String, java.lang.Object)">setObject</A>, <A HREF="../prefs/VSPrefs.html#setString(java.lang.String, java.lang.String)">setString</A>, <A HREF="../prefs/VSPrefs.html#setVector(java.lang.String, java.util.Vector)">setVector</A></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, wait, wait, wait</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="HAS_ON_SERVER_START"><!-- --></A><H3> +HAS_ON_SERVER_START</H3> +<PRE> +protected static final boolean <B>HAS_ON_SERVER_START</B></PRE> +<DL> +<DD>The protocol has an onServerStart method +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#protocols.VSAbstractProtocol.HAS_ON_SERVER_START">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="HAS_ON_CLIENT_START"><!-- --></A><H3> +HAS_ON_CLIENT_START</H3> +<PRE> +protected static final boolean <B>HAS_ON_CLIENT_START</B></PRE> +<DL> +<DD>The protocol has an onClientStart method +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#protocols.VSAbstractProtocol.HAS_ON_CLIENT_START">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="VSAbstractProtocol(boolean)"><!-- --></A><H3> +VSAbstractProtocol</H3> +<PRE> +public <B>VSAbstractProtocol</B>(boolean hasOnServerStart)</PRE> +<DL> +<DD>A simple constructor. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>hasOnServerStart</CODE> - true, if the protocol uses an onServerStart + method. false, if the protocol uses an onClientStart method instead.</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="sendMessage(core.VSMessage)"><!-- --></A><H3> +sendMessage</H3> +<PRE> +public void <B>sendMessage</B>(<A HREF="../core/VSMessage.html" title="class in core">VSMessage</A> message)</PRE> +<DL> +<DD>Sends a message. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to send</DL> +</DD> +</DL> +<HR> + +<A NAME="onStart()"><!-- --></A><H3> +onStart</H3> +<PRE> +public final void <B>onStart</B>()</PRE> +<DL> +<DD><B>Description copied from class: <CODE><A HREF="../events/VSAbstractEvent.html#onStart()">VSAbstractEvent</A></CODE></B></DD> +<DD>Every event can get started. This method get's executed if the event + takes place. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../events/VSAbstractEvent.html#onStart()">onStart</A></CODE> in class <CODE><A HREF="../events/VSAbstractEvent.html" title="class in events">VSAbstractEvent</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="onInit()"><!-- --></A><H3> +onInit</H3> +<PRE> +public final void <B>onInit</B>()</PRE> +<DL> +<DD><B>Description copied from class: <CODE><A HREF="../events/VSAbstractEvent.html#onInit()">VSAbstractEvent</A></CODE></B></DD> +<DD>Every event has its own initialize method. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../events/VSAbstractEvent.html#onInit()">onInit</A></CODE> in class <CODE><A HREF="../events/VSAbstractEvent.html" title="class in events">VSAbstractEvent</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="onClientScheduleStart()"><!-- --></A><H3> +onClientScheduleStart</H3> +<PRE> +public final void <B>onClientScheduleStart</B>()</PRE> +<DL> +<DD>Runs a client schedule +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="onServerScheduleStart()"><!-- --></A><H3> +onServerScheduleStart</H3> +<PRE> +public final void <B>onServerScheduleStart</B>()</PRE> +<DL> +<DD>Runs a server schedule +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="onMessageRecvStart(core.VSMessage)"><!-- --></A><H3> +onMessageRecvStart</H3> +<PRE> +public final void <B>onMessageRecvStart</B>(<A HREF="../core/VSMessage.html" title="class in core">VSMessage</A> message)</PRE> +<DL> +<DD>On message recv. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message</DL> +</DD> +</DL> +<HR> + +<A NAME="isRelevantMessage(core.VSMessage)"><!-- --></A><H3> +isRelevantMessage</H3> +<PRE> +public final boolean <B>isRelevantMessage</B>(<A HREF="../core/VSMessage.html" title="class in core">VSMessage</A> message)</PRE> +<DL> +<DD>Check's if its a relevant message. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to check +<DT><B>Returns:</B><DD>true, if it's a relevant meessage. false if the protocol + is wrong or if the server recv a server message/the client recv a + client message. Clients should only recv server messages and servers + should only recv client messages.</DL> +</DD> +</DL> +<HR> |