lejos_NXJ_win32_0_6_0beta.zip

[nxt-jsp/lejos_nxj.git] / nxtOSEK / lejos_nxj / src / java / pccomms / lejos / pc / comm / NXTComm.java

diff --git a/nxtOSEK/lejos_nxj/src/java/pccomms/lejos/pc/comm/NXTComm.java b/nxtOSEK/lejos_nxj/src/java/pccomms/lejos/pc/comm/NXTComm.java
index 73f31ae..4cb8228 100644 (file)
--- a/nxtOSEK/lejos_nxj/src/java/pccomms/lejos/pc/comm/NXTComm.java
+++ b/nxtOSEK/lejos_nxj/src/java/pccomms/lejos/pc/comm/NXTComm.java
@@ -2,14 +2,87 @@ package lejos.pc.comm;
 
 import java.io.*;
 
+/**
+ * 
+ * Interface that all NXTComm implementation classes must implement for low-level communication
+ * with the NXT.
+ *
+ */
 public interface NXTComm {
+       
+       /**
+        * Search for NXTs over USB, Bluetooth or both
+        * @param name name of the NXT or null
+        * @param protocol bitwise combination of NXTCommFactory.BLUETOOTH and NXTCommFactory.USB
+        * @return a NXTInfo object describing the NXt found and the connection to it
+        * @throws NXTCommException
+        */
        public NXTInfo[] search(String name, int protocol) throws NXTCommException;
+       
+       /**
+        * Connect to a NXT found by a search or created from mname and address.
+        * 
+        * @param nxt the NXTInfo object for the NXT
+        * @return true iff the open succeeded
+        * @throws NXTCommException
+        */
        public boolean open(NXTInfo nxt) throws NXTCommException;
+       
+       /**
+        * Closes the connection to the NXT.
+        * 
+        * @throws IOException
+        */
        public void close() throws IOException;
+       
+       /**
+        * Send an LCP message to the NXT and receive a reply
+        * 
+        * @param message the LCP message
+        * @param replyLen the reply length expected
+        * @return the reply
+        * @throws IOException
+        */
        public byte[] sendRequest(byte [] message, int replyLen) throws IOException;
+       
+       /**
+        * Read data from a NXT that has an open connection.
+        * Used for stream connections.
+        * 
+        * @return the data
+        * @throws IOException
+        */
        public byte[] read() throws IOException;
+       
+       /**
+        * Request the number of bytes available to read.
+        * 
+        * @return the number of bytes available
+        * @throws IOException
+        */
        public int available() throws IOException;
+       
+       /**
+        * Write data to a NXT that has an open connection.
+        * 
+        * @param data the data to be written.
+        * Used for stream connections.
+        * 
+        * @throws IOException
+        */
        public void write(byte [] data) throws IOException;
+       
+       /**
+        * Return an OutputStream for writing a stream of data to the NXT over this connection.
+        * 
+        * @return the OutputStream object
+        */
        public OutputStream getOutputStream();
+       
+       /**
+        * Return an InputStream for reading a stream of data from the NXT over this connection.
+        * 
+        * @return the InputStream object
+        */
        public InputStream getInputStream();
 }