--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
+<!--NewPage-->\r
+<HTML>\r
+<HEAD>\r
+<!-- Generated by javadoc (build 1.5.0_11) on Tue Apr 10 15:02:52 UTC 2007 -->\r
+<TITLE>\r
+PushCacheProtocol\r
+</TITLE>\r
+\r
+<META NAME="keywords" CONTENT="org.w3c.www.protocol.http.cache.push.PushCacheProtocol class">\r
+\r
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">\r
+\r
+<SCRIPT type="text/javascript">\r
+function windowTitle()\r
+{\r
+ parent.document.title="PushCacheProtocol";\r
+}\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+</NOSCRIPT>\r
+\r
+</HEAD>\r
+\r
+<BODY BGCOLOR="white" onload="windowTitle();">\r
+\r
+\r
+<!-- ========= START OF TOP NAVBAR ======= -->\r
+<A NAME="navbar_top"><!-- --></A>\r
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_top_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+ <TR ALIGN="center" VALIGN="top">\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>\r
+ </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+ <A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheManager.html" title="class in org.w3c.www.protocol.http.cache.push"><B>PREV CLASS</B></A> \r
+ <A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushEntityCachedResource.html" title="class in org.w3c.www.protocol.http.cache.push"><B>NEXT CLASS</B></A></FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+ <A HREF="../../../../../../../index.html?org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html" target="_top"><B>FRAMES</B></A> \r
+ <A HREF="PushCacheProtocol.html" target="_top"><B>NO FRAMES</B></A> \r
+ <SCRIPT type="text/javascript">\r
+ <!--\r
+ if(window==top) {\r
+ document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+ }\r
+ //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+ <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_top"></A>\r
+<!-- ========= END OF TOP NAVBAR ========= -->\r
+\r
+<HR>\r
+<!-- ======== START OF CLASS DATA ======== -->\r
+<H2>\r
+<FONT SIZE="-1">\r
+org.w3c.www.protocol.http.cache.push</FONT>\r
+<BR>\r
+Class PushCacheProtocol</H2>\r
+<PRE>\r
+java.lang.Object\r
+ <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.w3c.www.protocol.http.cache.push.PushCacheProtocol</B>\r
+</PRE>\r
+<HR>\r
+<DL>\r
+<DT><PRE>public class <B>PushCacheProtocol</B><DT>extends java.lang.Object</DL>\r
+</PRE>\r
+\r
+<P>\r
+PushCacheProtocol\r
+ Characteristics of the protocol used to control the push cache, and \r
+ methods for common operations\r
+ <p>\r
+ <b>Protocol Description</b>\r
+ <p>\r
+ To request that "/home/abc/page.html" is inserted in cache as \r
+ "http://www.abc.com/page.html" the client sends a packet with\r
+ command="ADD", and remain_len set to sizeof(add_packet_t) plus\r
+ the sum of the lengths of the path and the urls including their\r
+ null terminators. The client then sends an add_packet describing\r
+ the lengths of the two strings followed by the path and then the\r
+ url.\r
+ <p>\r
+ The server replies with either command="OK" and remain_len=0 or\r
+ command="ERR" and remain_len set the the length of the error\r
+ string that follows immediately. In the event of an "ERR" message\r
+ the connection is closed by the server.\r
+ <p>\r
+ To request that the page associated with "http://www.abc.com/page.html"\r
+ be removed from the cache the client sends a packet with command="DEL",\r
+ and remain_len set to sizeof(int) plus the length of the url string\r
+ including the trailing null character. The server replies as with\r
+ ADD above. Attempting to remove a url that is not present in the cache\r
+ results in an "OK" packet being returned, the cache is unchanged.\r
+ <p>\r
+ The client can ask if a url is present in the cache by sending a packet\r
+ with command="PRS", and url information as with the DEL command. The\r
+ server will reply with "OK" if the url is present, "NO" if the url is\r
+ not present and "ERR" if an error was encountered.\r
+ <p>\r
+ The client can request that the cache be emptied of all urls by sending\r
+ a packet with command="CLN" (clean). The remain_len field is set to zero.\r
+ The server will reply with either OK or ERR.\r
+ \r
+ <p>\r
+ The client can terminate the dialogue by sending a command="BYE" \r
+ packet and then closing the connection.\r
+ \r
+ <p>\r
+ 'C' code describing the packet structures are shown below\r
+\r
+\r
+<pre>\r
+ typedef struct {\r
+ // Bytes Notes\r
+ // ----- -----\r
+ char tag[4]; // 0-3 = {'P','C','P','P'}\r
+ short major_version; // 4-5 = 1\r
+ short minor_version; // 6-7 = 1\r
+ char command[4]; // 8-11 Null terminated command string \r
+ int remain_len; // 12-15 number of remaining bytes to read\r
+ } packet_t;\r
+\r
+ typedef struct {\r
+ int path_len; // 4 Length of pathname (including null)\r
+ int url_len; // 8 Length of URL (including null)\r
+ } add_packet_t;\r
+ \r
+ Note that the command is always 4 characters in length and that the\r
+ null characters are considered part of the command, so in Java (but\r
+ not C) we must include the \0 when comparing strings:\r
+ "ADD\0", "BYE\0", "OK\0\0", "ERR\0", "CLN\0", "PRS\0", "DEL\0"\r
+\r
+ </pre>\r
+<P>\r
+\r
+<P>\r
+<HR>\r
+\r
+<P>\r
+<!-- =========== FIELD SUMMARY =========== -->\r
+\r
+<A NAME="field_summary"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
+<B>Field Summary</B></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#ADD">ADD</A></B></CODE>\r
+\r
+<BR>\r
+ Numeric codes for commands,</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#BYE">BYE</A></B></CODE>\r
+\r
+<BR>\r
+ Numeric codes for commands,</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#CLN">CLN</A></B></CODE>\r
+\r
+<BR>\r
+ Numeric codes for commands,</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#COMMAND_LEN">COMMAND_LEN</A></B></CODE>\r
+\r
+<BR>\r
+ Size of command string in bytes (including null terminator)</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#DEL">DEL</A></B></CODE>\r
+\r
+<BR>\r
+ Numeric codes for commands,</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#ERR">ERR</A></B></CODE>\r
+\r
+<BR>\r
+ Numeric codes for commands,</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#HEADER_LEN">HEADER_LEN</A></B></CODE>\r
+\r
+<BR>\r
+ Combined size of tag and version information</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static short</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#MAJ_PROTO_VERSION">MAJ_PROTO_VERSION</A></B></CODE>\r
+\r
+<BR>\r
+ Protocol Major version</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#MAX_PAYLOAD_LEN">MAX_PAYLOAD_LEN</A></B></CODE>\r
+\r
+<BR>\r
+ Maximum size of payload (follows basic packet)</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#MAX_STRING_LEN">MAX_STRING_LEN</A></B></CODE>\r
+\r
+<BR>\r
+ Maximum size of strings (urls, paths, error messages)</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static short</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#MIN_PROTO_VERSION">MIN_PROTO_VERSION</A></B></CODE>\r
+\r
+<BR>\r
+ Protocol minor version</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#NO">NO</A></B></CODE>\r
+\r
+<BR>\r
+ Numeric codes for commands,</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#NO_SUCH_COMMAND">NO_SUCH_COMMAND</A></B></CODE>\r
+\r
+<BR>\r
+ Numeric codes for commands,</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#NOP">NOP</A></B></CODE>\r
+\r
+<BR>\r
+ Numeric codes for commands,</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#OK">OK</A></B></CODE>\r
+\r
+<BR>\r
+ Numeric codes for commands,</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#PACKET_LEN">PACKET_LEN</A></B></CODE>\r
+\r
+<BR>\r
+ Size of basic packet in bytes</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#PRS">PRS</A></B></CODE>\r
+\r
+<BR>\r
+ Numeric codes for commands,</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#TAG_LEN">TAG_LEN</A></B></CODE>\r
+\r
+<BR>\r
+ Size of packet tag</TD>\r
+</TR>\r
+</TABLE>\r
+ \r
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
+\r
+<A NAME="constructor_summary"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
+<B>Constructor Summary</B></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>protected </CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#PushCacheProtocol()">PushCacheProtocol</A></B>()</CODE>\r
+\r
+<BR>\r
+ Singleton, no public constructor, use <A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#instance()"><CODE>instance()</CODE></A></TD>\r
+</TR>\r
+</TABLE>\r
+ \r
+<!-- ========== METHOD SUMMARY =========== -->\r
+\r
+<A NAME="method_summary"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
+<B>Method Summary</B></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> byte[]</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#errorPacket(java.lang.String)">errorPacket</A></B>(java.lang.String message)</CODE>\r
+\r
+<BR>\r
+ Create error packet for specified error message</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> byte[]</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#header()">header</A></B>()</CODE>\r
+\r
+<BR>\r
+ </TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static <A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html" title="class in org.w3c.www.protocol.http.cache.push">PushCacheProtocol</A></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#instance()">instance</A></B>()</CODE>\r
+\r
+<BR>\r
+ Access to single instance of this class</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> boolean</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#isValidProtocolTag(byte[])">isValidProtocolTag</A></B>(byte[] packet)</CODE>\r
+\r
+<BR>\r
+ True iff first four bytes of packet are identical to the protocol tag</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> byte[]</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#noPacket()">noPacket</A></B>()</CODE>\r
+\r
+<BR>\r
+ Byte array for NO packet</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> byte[]</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#okPacket()">okPacket</A></B>()</CODE>\r
+\r
+<BR>\r
+ Byte array for OK packet</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#parseCommand(java.lang.String)">parseCommand</A></B>(java.lang.String command)</CODE>\r
+\r
+<BR>\r
+ Utility function for command string parsing</TD>\r
+</TR>\r
+</TABLE>\r
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
+</TR>\r
+</TABLE>\r
+ \r
+<P>\r
+\r
+<!-- ============ FIELD DETAIL =========== -->\r
+\r
+<A NAME="field_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Field Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="PACKET_LEN"><!-- --></A><H3>\r
+PACKET_LEN</H3>\r
+<PRE>\r
+public static final int <B>PACKET_LEN</B></PRE>\r
+<DL>\r
+<DD>Size of basic packet in bytes\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.PACKET_LEN">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="COMMAND_LEN"><!-- --></A><H3>\r
+COMMAND_LEN</H3>\r
+<PRE>\r
+public static final int <B>COMMAND_LEN</B></PRE>\r
+<DL>\r
+<DD>Size of command string in bytes (including null terminator)\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.COMMAND_LEN">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="HEADER_LEN"><!-- --></A><H3>\r
+HEADER_LEN</H3>\r
+<PRE>\r
+public static final int <B>HEADER_LEN</B></PRE>\r
+<DL>\r
+<DD>Combined size of tag and version information\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.HEADER_LEN">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="TAG_LEN"><!-- --></A><H3>\r
+TAG_LEN</H3>\r
+<PRE>\r
+public static final int <B>TAG_LEN</B></PRE>\r
+<DL>\r
+<DD>Size of packet tag\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.TAG_LEN">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="MAX_STRING_LEN"><!-- --></A><H3>\r
+MAX_STRING_LEN</H3>\r
+<PRE>\r
+public static final int <B>MAX_STRING_LEN</B></PRE>\r
+<DL>\r
+<DD>Maximum size of strings (urls, paths, error messages)\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.MAX_STRING_LEN">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="MAX_PAYLOAD_LEN"><!-- --></A><H3>\r
+MAX_PAYLOAD_LEN</H3>\r
+<PRE>\r
+public static final int <B>MAX_PAYLOAD_LEN</B></PRE>\r
+<DL>\r
+<DD>Maximum size of payload (follows basic packet)\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.MAX_PAYLOAD_LEN">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="MAJ_PROTO_VERSION"><!-- --></A><H3>\r
+MAJ_PROTO_VERSION</H3>\r
+<PRE>\r
+public static final short <B>MAJ_PROTO_VERSION</B></PRE>\r
+<DL>\r
+<DD>Protocol Major version\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.MAJ_PROTO_VERSION">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="MIN_PROTO_VERSION"><!-- --></A><H3>\r
+MIN_PROTO_VERSION</H3>\r
+<PRE>\r
+public static final short <B>MIN_PROTO_VERSION</B></PRE>\r
+<DL>\r
+<DD>Protocol minor version\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.MIN_PROTO_VERSION">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="NO_SUCH_COMMAND"><!-- --></A><H3>\r
+NO_SUCH_COMMAND</H3>\r
+<PRE>\r
+public static final int <B>NO_SUCH_COMMAND</B></PRE>\r
+<DL>\r
+<DD>Numeric codes for commands,\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.NO_SUCH_COMMAND">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="ERR"><!-- --></A><H3>\r
+ERR</H3>\r
+<PRE>\r
+public static final int <B>ERR</B></PRE>\r
+<DL>\r
+<DD>Numeric codes for commands,\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.ERR">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="ADD"><!-- --></A><H3>\r
+ADD</H3>\r
+<PRE>\r
+public static final int <B>ADD</B></PRE>\r
+<DL>\r
+<DD>Numeric codes for commands,\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.ADD">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="DEL"><!-- --></A><H3>\r
+DEL</H3>\r
+<PRE>\r
+public static final int <B>DEL</B></PRE>\r
+<DL>\r
+<DD>Numeric codes for commands,\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.DEL">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="CLN"><!-- --></A><H3>\r
+CLN</H3>\r
+<PRE>\r
+public static final int <B>CLN</B></PRE>\r
+<DL>\r
+<DD>Numeric codes for commands,\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.CLN">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="PRS"><!-- --></A><H3>\r
+PRS</H3>\r
+<PRE>\r
+public static final int <B>PRS</B></PRE>\r
+<DL>\r
+<DD>Numeric codes for commands,\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.PRS">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="BYE"><!-- --></A><H3>\r
+BYE</H3>\r
+<PRE>\r
+public static final int <B>BYE</B></PRE>\r
+<DL>\r
+<DD>Numeric codes for commands,\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.BYE">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="OK"><!-- --></A><H3>\r
+OK</H3>\r
+<PRE>\r
+public static final int <B>OK</B></PRE>\r
+<DL>\r
+<DD>Numeric codes for commands,\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.OK">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="NO"><!-- --></A><H3>\r
+NO</H3>\r
+<PRE>\r
+public static final int <B>NO</B></PRE>\r
+<DL>\r
+<DD>Numeric codes for commands,\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.NO">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="NOP"><!-- --></A><H3>\r
+NOP</H3>\r
+<PRE>\r
+public static final int <B>NOP</B></PRE>\r
+<DL>\r
+<DD>Numeric codes for commands,\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.w3c.www.protocol.http.cache.push.PushCacheProtocol.NOP">Constant Field Values</A></DL>\r
+</DL>\r
+\r
+<!-- ========= CONSTRUCTOR DETAIL ======== -->\r
+\r
+<A NAME="constructor_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Constructor Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="PushCacheProtocol()"><!-- --></A><H3>\r
+PushCacheProtocol</H3>\r
+<PRE>\r
+protected <B>PushCacheProtocol</B>()</PRE>\r
+<DL>\r
+<DD>Singleton, no public constructor, use <A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#instance()"><CODE>instance()</CODE></A>\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html#instance()"><CODE>instance()</CODE></A></DL>\r
+</DL>\r
+\r
+<!-- ============ METHOD DETAIL ========== -->\r
+\r
+<A NAME="method_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Method Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="instance()"><!-- --></A><H3>\r
+instance</H3>\r
+<PRE>\r
+public static <A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html" title="class in org.w3c.www.protocol.http.cache.push">PushCacheProtocol</A> <B>instance</B>()</PRE>\r
+<DL>\r
+<DD>Access to single instance of this class\r
+<P>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="parseCommand(java.lang.String)"><!-- --></A><H3>\r
+parseCommand</H3>\r
+<PRE>\r
+public int <B>parseCommand</B>(java.lang.String command)</PRE>\r
+<DL>\r
+<DD>Utility function for command string parsing\r
+<P>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="okPacket()"><!-- --></A><H3>\r
+okPacket</H3>\r
+<PRE>\r
+public byte[] <B>okPacket</B>()</PRE>\r
+<DL>\r
+<DD>Byte array for OK packet\r
+<P>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="noPacket()"><!-- --></A><H3>\r
+noPacket</H3>\r
+<PRE>\r
+public byte[] <B>noPacket</B>()</PRE>\r
+<DL>\r
+<DD>Byte array for NO packet\r
+<P>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="header()"><!-- --></A><H3>\r
+header</H3>\r
+<PRE>\r
+public byte[] <B>header</B>()</PRE>\r
+<DL>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="errorPacket(java.lang.String)"><!-- --></A><H3>\r
+errorPacket</H3>\r
+<PRE>\r
+public byte[] <B>errorPacket</B>(java.lang.String message)</PRE>\r
+<DL>\r
+<DD>Create error packet for specified error message\r
+<P>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="isValidProtocolTag(byte[])"><!-- --></A><H3>\r
+isValidProtocolTag</H3>\r
+<PRE>\r
+public boolean <B>isValidProtocolTag</B>(byte[] packet)</PRE>\r
+<DL>\r
+<DD>True iff first four bytes of packet are identical to the protocol tag\r
+<P>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<!-- ========= END OF CLASS DATA ========= -->\r
+<HR>\r
+\r
+\r
+<!-- ======= START OF BOTTOM NAVBAR ====== -->\r
+<A NAME="navbar_bottom"><!-- --></A>\r
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_bottom_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+ <TR ALIGN="center" VALIGN="top">\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>\r
+ </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+ <A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushCacheManager.html" title="class in org.w3c.www.protocol.http.cache.push"><B>PREV CLASS</B></A> \r
+ <A HREF="../../../../../../../org/w3c/www/protocol/http/cache/push/PushEntityCachedResource.html" title="class in org.w3c.www.protocol.http.cache.push"><B>NEXT CLASS</B></A></FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+ <A HREF="../../../../../../../index.html?org/w3c/www/protocol/http/cache/push/PushCacheProtocol.html" target="_top"><B>FRAMES</B></A> \r
+ <A HREF="PushCacheProtocol.html" target="_top"><B>NO FRAMES</B></A> \r
+ <SCRIPT type="text/javascript">\r
+ <!--\r
+ if(window==top) {\r
+ document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+ }\r
+ //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+ <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_bottom"></A>\r
+<!-- ======== END OF BOTTOM NAVBAR ======= -->\r
+\r
+<HR>\r
+\r
+</BODY>\r
+</HTML>\r
projects / Benchmarks_CSolver.git / blobdiff