nxtOSEK/lejos_nxj/docs/apidocs/lejos/nxt/comm/BTInputStream.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.5.0_09) on Tue Jan 08 20:46:01 GMT 2008 -->
   6 <TITLE>
   7 BTInputStream (leJOS NXT API documentation)
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="lejos.nxt.comm.BTInputStream class">
  11
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  13
  14 <SCRIPT type="text/javascript">
  15 function windowTitle()
  16 {
  17     parent.document.title="BTInputStream (leJOS NXT API documentation)";
  18 }
  19 </SCRIPT>
  20 <NOSCRIPT>
  21 </NOSCRIPT>
  22
  23 </HEAD>
  24
  25 <BODY BGCOLOR="white" onload="windowTitle();">
  26
  27
  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="">
  32 <TR>
  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>&nbsp;</TD>
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  39   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  44   </TR>
  45 </TABLE>
  46 </TD>
  47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  48 </EM>
  49 </TD>
  50 </TR>
  51
  52 <TR>
  53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54 &nbsp;<A HREF="../../../lejos/nxt/comm/BTConnection.html" title="class in lejos.nxt.comm"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../../lejos/nxt/comm/BTOutputStream.html" title="class in lejos.nxt.comm"><B>NEXT CLASS</B></A></FONT></TD>
  56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  57   <A HREF="../../../index.html?lejos/nxt/comm/BTInputStream.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="BTInputStream.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  59 &nbsp;<SCRIPT type="text/javascript">
  60   <!--
  61   if(window==top) {
  62     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  63   }
  64   //-->
  65 </SCRIPT>
  66 <NOSCRIPT>
  67   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  68 </NOSCRIPT>
  69
  70
  71 </FONT></TD>
  72 </TR>
  73 <TR>
  74 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  75   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  77 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  78 </TR>
  79 </TABLE>
  80 <A NAME="skip-navbar_top"></A>
  81 <!-- ========= END OF TOP NAVBAR ========= -->
  82
  83 <HR>
  84 <!-- ======== START OF CLASS DATA ======== -->
  85 <H2>
  86 <FONT SIZE="-1">
  87 lejos.nxt.comm</FONT>
  88 <BR>
  89 Class BTInputStream</H2>
  90 <PRE>
  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="../../../java/io/InputStream.html" title="class in java.io">java.io.InputStream</A>
  93       <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>lejos.nxt.comm.BTInputStream</B>
  94 </PRE>
  95 <HR>
  96 <DL>
  97 <DT><PRE>public class <B>BTInputStream</B><DT>extends <A HREF="../../../java/io/InputStream.html" title="class in java.io">InputStream</A></DL>
  98 </PRE>
  99
 100 <P>
 101 Extends InputStream for BlueTooth; implements available()
 102 <P>
 103
 104 <P>
 105 <DL>
 106 <DT><B>Author:</B></DT>
 107   <DD>Roger Glassey revised on june 23, 2007, modified for Bluetooth2</DD>
 108 </DL>
 109 <HR>
 110
 111 <P>
 112
 113 <!-- ========== METHOD SUMMARY =========== -->
 114
 115 <A NAME="method_summary"><!-- --></A>
 116 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 117 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 118 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 119 <B>Method Summary</B></FONT></TH>
 120 </TR>
 121 <TR BGCOLOR="white" CLASS="TableRowColor">
 122 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 123 <CODE>&nbsp;int</CODE></FONT></TD>
 124 <TD><CODE><B><A HREF="../../../lejos/nxt/comm/BTInputStream.html#available()">available</A></B>()</CODE>
 125
 126 <BR>
 127 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns the number of bytes in the input buffer - can be read without blocking</TD>
 128 </TR>
 129 <TR BGCOLOR="white" CLASS="TableRowColor">
 130 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 131 <CODE>&nbsp;void</CODE></FONT></TD>
 132 <TD><CODE><B><A HREF="../../../lejos/nxt/comm/BTInputStream.html#close()">close</A></B>()</CODE>
 133
 134 <BR>
 135 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the stream is restored to its original state - ready to receive more data.</TD>
 136 </TR>
 137 <TR BGCOLOR="white" CLASS="TableRowColor">
 138 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 139 <CODE>&nbsp;int</CODE></FONT></TD>
 140 <TD><CODE><B><A HREF="../../../lejos/nxt/comm/BTInputStream.html#read()">read</A></B>()</CODE>
 141
 142 <BR>
 143 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns one byte as an integer between 0 and 255.</TD>
 144 </TR>
 145 </TABLE>
 146 &nbsp;<A NAME="methods_inherited_from_class_java.io.InputStream"><!-- --></A>
 147 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 148 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 149 <TH ALIGN="left"><B>Methods inherited from class java.io.<A HREF="../../../java/io/InputStream.html" title="class in java.io">InputStream</A></B></TH>
 150 </TR>
 151 <TR BGCOLOR="white" CLASS="TableRowColor">
 152 <TD><CODE><A HREF="../../../java/io/InputStream.html#mark(int)">mark</A>, <A HREF="../../../java/io/InputStream.html#markSupported()">markSupported</A>, <A HREF="../../../java/io/InputStream.html#read(byte[])">read</A>, <A HREF="../../../java/io/InputStream.html#read(byte[], int, int)">read</A>, <A HREF="../../../java/io/InputStream.html#reset()">reset</A>, <A HREF="../../../java/io/InputStream.html#skip(long)">skip</A></CODE></TD>
 153 </TR>
 154 </TABLE>
 155 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 156 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 157 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 158 <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>
 159 </TR>
 160 <TR BGCOLOR="white" CLASS="TableRowColor">
 161 <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>
 162 </TR>
 163 </TABLE>
 164 &nbsp;
 165 <P>
 166
 167 <!-- ============ METHOD DETAIL ========== -->
 168
 169 <A NAME="method_detail"><!-- --></A>
 170 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 171 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 172 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 173 <B>Method Detail</B></FONT></TH>
 174 </TR>
 175 </TABLE>
 176
 177 <A NAME="read()"><!-- --></A><H3>
 178 read</H3>
 179 <PRE>
 180 public int <B>read</B>()</PRE>
 181 <DL>
 182 <DD>Returns one byte as an integer between 0 and 255.
 183  Returns -1 if the end of the stream is reached.
 184  Does not return till some bytes are available.
 185 <P>
 186 <DD><DL>
 187 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../java/io/InputStream.html#read()">read</A></CODE> in class <CODE><A HREF="../../../java/io/InputStream.html" title="class in java.io">InputStream</A></CODE></DL>
 188 </DD>
 189 <DD><DL>
 190
 191 <DT><B>Returns:</B><DD>the next byte of data, or <code>-1</code> if the end of the
 192              stream is reached.</DL>
 193 </DD>
 194 </DL>
 195 <HR>
 196
 197 <A NAME="available()"><!-- --></A><H3>
 198 available</H3>
 199 <PRE>
 200 public int <B>available</B>()</PRE>
 201 <DL>
 202 <DD>returns the number of bytes in the input buffer - can be read without blocking
 203 <P>
 204 <DD><DL>
 205 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../java/io/InputStream.html#available()">available</A></CODE> in class <CODE><A HREF="../../../java/io/InputStream.html" title="class in java.io">InputStream</A></CODE></DL>
 206 </DD>
 207 <DD><DL>
 208
 209 <DT><B>Returns:</B><DD>the number of bytes that can be read from this input stream
 210              without blocking.</DL>
 211 </DD>
 212 </DL>
 213 <HR>
 214
 215 <A NAME="close()"><!-- --></A><H3>
 216 close</H3>
 217 <PRE>
 218 public void <B>close</B>()</PRE>
 219 <DL>
 220 <DD>the stream is restored to its original state - ready to receive more data.
 221 <P>
 222 <DD><DL>
 223 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../java/io/InputStream.html#close()">close</A></CODE> in class <CODE><A HREF="../../../java/io/InputStream.html" title="class in java.io">InputStream</A></CODE></DL>
 224 </DD>
 225 <DD><DL>
 226 </DL>
 227 </DD>
 228 </DL>
 229 <!-- ========= END OF CLASS DATA ========= -->
 230 <HR>
 231
 232
 233 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 234 <A NAME="navbar_bottom"><!-- --></A>
 235 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 236 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 237 <TR>
 238 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 239 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 240 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 241   <TR ALIGN="center" VALIGN="top">
 242   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 243   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 244   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 245   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 246   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 247   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 248   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 249   </TR>
 250 </TABLE>
 251 </TD>
 252 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 253 </EM>
 254 </TD>
 255 </TR>
 256
 257 <TR>
 258 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 259 &nbsp;<A HREF="../../../lejos/nxt/comm/BTConnection.html" title="class in lejos.nxt.comm"><B>PREV CLASS</B></A>&nbsp;
 260 &nbsp;<A HREF="../../../lejos/nxt/comm/BTOutputStream.html" title="class in lejos.nxt.comm"><B>NEXT CLASS</B></A></FONT></TD>
 261 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 262   <A HREF="../../../index.html?lejos/nxt/comm/BTInputStream.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 263 &nbsp;<A HREF="BTInputStream.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 264 &nbsp;<SCRIPT type="text/javascript">
 265   <!--
 266   if(window==top) {
 267     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
 268   }
 269   //-->
 270 </SCRIPT>
 271 <NOSCRIPT>
 272   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
 273 </NOSCRIPT>
 274
 275
 276 </FONT></TD>
 277 </TR>
 278 <TR>
 279 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 280   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 281 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 282 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 283 </TR>
 284 </TABLE>
 285 <A NAME="skip-navbar_bottom"></A>
 286 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 287
 288 <HR>
 289
 290 </BODY>
 291 </HTML>