1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (build 1.5.0_09) on Tue Jan 08 20:46:00 GMT 2008 -->
7 LLCHandler (leJOS NXT API documentation)
10 <META NAME="keywords" CONTENT="lejos.rcxcomm.LLCHandler class">
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
14 <SCRIPT type="text/javascript">
15 function windowTitle()
17 parent.document.title="LLCHandler (leJOS NXT API documentation)";
25 <BODY BGCOLOR="white" onload="windowTitle();">
28 <!-- ========= START OF TOP NAVBAR ======= -->
29 <A NAME="navbar_top"><!-- --></A>
30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34 <A NAME="navbar_top_firstrow"><!-- --></A>
35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36 <TR ALIGN="center" VALIGN="top">
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54 <A HREF="../../lejos/rcxcomm/LLC.html" title="class in lejos.rcxcomm"><B>PREV CLASS</B></A>
55 <A HREF="../../lejos/rcxcomm/LLCReliableHandler.html" title="class in lejos.rcxcomm"><B>NEXT CLASS</B></A></FONT></TD>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../index.html?lejos/rcxcomm/LLCHandler.html" target="_top"><B>FRAMES</B></A>
58 <A HREF="LLCHandler.html" target="_top"><B>NO FRAMES</B></A>
59 <SCRIPT type="text/javascript">
62 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
67 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
74 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_lejos.rcxcomm.PacketHandler">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
80 <A NAME="skip-navbar_top"></A>
81 <!-- ========= END OF TOP NAVBAR ========= -->
84 <!-- ======== START OF CLASS DATA ======== -->
91 <A HREF="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</A>
92 <IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="../../lejos/rcxcomm/PacketHandler.html" title="class in lejos.rcxcomm">lejos.rcxcomm.PacketHandler</A>
93 <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>lejos.rcxcomm.LLCHandler</B>
97 <DT><PRE>public class <B>LLCHandler</B><DT>extends <A HREF="../../lejos/rcxcomm/PacketHandler.html" title="class in lejos.rcxcomm">PacketHandler</A></DL>
101 Packet handler than implement the LLC packet protocol.
102 Deals with packets and acks.
103 Supports independent streams of data in both directions.
110 <!-- =========== FIELD SUMMARY =========== -->
112 <A NAME="field_summary"><!-- --></A>
113 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
114 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
115 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
116 <B>Field Summary</B></FONT></TH>
119 <A NAME="fields_inherited_from_class_lejos.rcxcomm.PacketHandler"><!-- --></A>
120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
121 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
122 <TH ALIGN="left"><B>Fields inherited from class lejos.rcxcomm.<A HREF="../../lejos/rcxcomm/PacketHandler.html" title="class in lejos.rcxcomm">PacketHandler</A></B></TH>
124 <TR BGCOLOR="white" CLASS="TableRowColor">
125 <TD><CODE><A HREF="../../lejos/rcxcomm/PacketHandler.html#lowerHandler">lowerHandler</A></CODE></TD>
129 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
131 <A NAME="constructor_summary"><!-- --></A>
132 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
135 <B>Constructor Summary</B></FONT></TH>
137 <TR BGCOLOR="white" CLASS="TableRowColor">
138 <TD><CODE><B><A HREF="../../lejos/rcxcomm/LLCHandler.html#LLCHandler(lejos.nxt.SensorPort)">LLCHandler</A></B>(<A HREF="../../lejos/nxt/SensorPort.html" title="class in lejos.nxt">SensorPort</A> port)</CODE>
141 </TD>
145 <!-- ========== METHOD SUMMARY =========== -->
147 <A NAME="method_summary"><!-- --></A>
148 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
149 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
150 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
151 <B>Method Summary</B></FONT></TH>
153 <TR BGCOLOR="white" CLASS="TableRowColor">
154 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155 <CODE> boolean</CODE></FONT></TD>
156 <TD><CODE><B><A HREF="../../lejos/rcxcomm/LLCHandler.html#isAckAvailable()">isAckAvailable</A></B>()</CODE>
159 Check if an Ack is available</TD>
161 <TR BGCOLOR="white" CLASS="TableRowColor">
162 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163 <CODE> boolean</CODE></FONT></TD>
164 <TD><CODE><B><A HREF="../../lejos/rcxcomm/LLCHandler.html#isPacketAvailable()">isPacketAvailable</A></B>()</CODE>
167 Check if a packet is available</TD>
169 <TR BGCOLOR="white" CLASS="TableRowColor">
170 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171 <CODE> int</CODE></FONT></TD>
172 <TD><CODE><B><A HREF="../../lejos/rcxcomm/LLCHandler.html#receiveAck(byte[])">receiveAck</A></B>(byte[] buffer)</CODE>
175 Receive an ack.</TD>
177 <TR BGCOLOR="white" CLASS="TableRowColor">
178 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179 <CODE> int</CODE></FONT></TD>
180 <TD><CODE><B><A HREF="../../lejos/rcxcomm/LLCHandler.html#receivePacket(byte[])">receivePacket</A></B>(byte[] buffer)</CODE>
183 Receive a packet.</TD>
185 <TR BGCOLOR="white" CLASS="TableRowColor">
186 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187 <CODE> boolean</CODE></FONT></TD>
188 <TD><CODE><B><A HREF="../../lejos/rcxcomm/LLCHandler.html#sendPacket(byte[], int)">sendPacket</A></B>(byte[] packet,
192 Send a packet.</TD>
195 <A NAME="methods_inherited_from_class_lejos.rcxcomm.PacketHandler"><!-- --></A>
196 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
197 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
198 <TH ALIGN="left"><B>Methods inherited from class lejos.rcxcomm.<A HREF="../../lejos/rcxcomm/PacketHandler.html" title="class in lejos.rcxcomm">PacketHandler</A></B></TH>
200 <TR BGCOLOR="white" CLASS="TableRowColor">
201 <TD><CODE><A HREF="../../lejos/rcxcomm/PacketHandler.html#close()">close</A>, <A HREF="../../lejos/rcxcomm/PacketHandler.html#getError()">getError</A>, <A HREF="../../lejos/rcxcomm/PacketHandler.html#open(byte, byte)">open</A>, <A HREF="../../lejos/rcxcomm/PacketHandler.html#reset()">reset</A>, <A HREF="../../lejos/rcxcomm/PacketHandler.html#setListen(boolean)">setListen</A></CODE></TD>
204 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
205 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
206 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
207 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></B></TH>
209 <TR BGCOLOR="white" CLASS="TableRowColor">
210 <TD><CODE><A HREF="../../java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="../../java/lang/Object.html#getClass()">getClass</A>, <A HREF="../../java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="../../java/lang/Object.html#notify()">notify</A>, <A HREF="../../java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="../../java/lang/Object.html#toString()">toString</A>, <A HREF="../../java/lang/Object.html#wait()">wait</A>, <A HREF="../../java/lang/Object.html#wait(long)">wait</A></CODE></TD>
216 <!-- ========= CONSTRUCTOR DETAIL ======== -->
218 <A NAME="constructor_detail"><!-- --></A>
219 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
220 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
221 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
222 <B>Constructor Detail</B></FONT></TH>
226 <A NAME="LLCHandler(lejos.nxt.SensorPort)"><!-- --></A><H3>
229 public <B>LLCHandler</B>(<A HREF="../../lejos/nxt/SensorPort.html" title="class in lejos.nxt">SensorPort</A> port)</PRE>
233 <!-- ============ METHOD DETAIL ========== -->
235 <A NAME="method_detail"><!-- --></A>
236 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
237 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
238 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
239 <B>Method Detail</B></FONT></TH>
243 <A NAME="sendPacket(byte[], int)"><!-- --></A><H3>
246 public boolean <B>sendPacket</B>(byte[] packet,
252 <DT><B>Specified by:</B><DD><CODE><A HREF="../../lejos/rcxcomm/PacketHandler.html#sendPacket(byte[], int)">sendPacket</A></CODE> in class <CODE><A HREF="../../lejos/rcxcomm/PacketHandler.html" title="class in lejos.rcxcomm">PacketHandler</A></CODE></DL>
255 <DT><B>Parameters:</B><DD><CODE>packet</CODE> - the bytes to send<DD><CODE>len</CODE> - the number of bytes to send
256 <DT><B>Returns:</B><DD>true if the send was successful, else false</DL>
261 <A NAME="receivePacket(byte[])"><!-- --></A><H3>
264 public int <B>receivePacket</B>(byte[] buffer)</PRE>
266 <DD>Receive a packet.
269 <DT><B>Specified by:</B><DD><CODE><A HREF="../../lejos/rcxcomm/PacketHandler.html#receivePacket(byte[])">receivePacket</A></CODE> in class <CODE><A HREF="../../lejos/rcxcomm/PacketHandler.html" title="class in lejos.rcxcomm">PacketHandler</A></CODE></DL>
272 <DT><B>Parameters:</B><DD><CODE>buffer</CODE> - the buffer to receive the packet into
273 <DT><B>Returns:</B><DD>the number of bytes received</DL>
278 <A NAME="receiveAck(byte[])"><!-- --></A><H3>
281 public int <B>receiveAck</B>(byte[] buffer)</PRE>
286 <DT><B>Overrides:</B><DD><CODE><A HREF="../../lejos/rcxcomm/PacketHandler.html#receiveAck(byte[])">receiveAck</A></CODE> in class <CODE><A HREF="../../lejos/rcxcomm/PacketHandler.html" title="class in lejos.rcxcomm">PacketHandler</A></CODE></DL>
289 <DT><B>Parameters:</B><DD><CODE>buffer</CODE> - the buffer to receive the ack into
290 <DT><B>Returns:</B><DD>the number of bytes received</DL>
295 <A NAME="isPacketAvailable()"><!-- --></A><H3>
296 isPacketAvailable</H3>
298 public boolean <B>isPacketAvailable</B>()</PRE>
300 <DD>Check if a packet is available
303 <DT><B>Specified by:</B><DD><CODE><A HREF="../../lejos/rcxcomm/PacketHandler.html#isPacketAvailable()">isPacketAvailable</A></CODE> in class <CODE><A HREF="../../lejos/rcxcomm/PacketHandler.html" title="class in lejos.rcxcomm">PacketHandler</A></CODE></DL>
307 <DT><B>Returns:</B><DD>true if a Packet is available, else false</DL>
312 <A NAME="isAckAvailable()"><!-- --></A><H3>
315 public boolean <B>isAckAvailable</B>()</PRE>
317 <DD>Check if an Ack is available
320 <DT><B>Overrides:</B><DD><CODE><A HREF="../../lejos/rcxcomm/PacketHandler.html#isAckAvailable()">isAckAvailable</A></CODE> in class <CODE><A HREF="../../lejos/rcxcomm/PacketHandler.html" title="class in lejos.rcxcomm">PacketHandler</A></CODE></DL>
324 <DT><B>Returns:</B><DD>true if ack is available, else false</DL>
327 <!-- ========= END OF CLASS DATA ========= -->
331 <!-- ======= START OF BOTTOM NAVBAR ====== -->
332 <A NAME="navbar_bottom"><!-- --></A>
333 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
334 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
336 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
337 <A NAME="navbar_bottom_firstrow"><!-- --></A>
338 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
339 <TR ALIGN="center" VALIGN="top">
340 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
341 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
342 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
343 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
344 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
345 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
346 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
350 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
356 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
357 <A HREF="../../lejos/rcxcomm/LLC.html" title="class in lejos.rcxcomm"><B>PREV CLASS</B></A>
358 <A HREF="../../lejos/rcxcomm/LLCReliableHandler.html" title="class in lejos.rcxcomm"><B>NEXT CLASS</B></A></FONT></TD>
359 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
360 <A HREF="../../index.html?lejos/rcxcomm/LLCHandler.html" target="_top"><B>FRAMES</B></A>
361 <A HREF="LLCHandler.html" target="_top"><B>NO FRAMES</B></A>
362 <SCRIPT type="text/javascript">
365 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
370 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
377 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
378 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_lejos.rcxcomm.PacketHandler">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
379 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
380 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
383 <A NAME="skip-navbar_bottom"></A>
384 <!-- ======== END OF BOTTOM NAVBAR ======= -->