SerialInputStream (JanosRuntime JavaDOC)

java.lang.Object
- java.io.InputStream
- - com.integpg.comm.SerialInputStream

public class SerialInputStream
extends InputStream

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AUXIN` AUXIN stram handles incoming data from the AUX serial port
`static int`	`AUXOUT` AUXOUT stram handles outgoing data to the AUX serial port
`static int`	`COMIN` COMIN stream handles incoming data from the RS-232 port (COM)
`static int`	`COMOUT` COMOUT stream handles outgoing data to the RS-232 port (COM)
`int`	`echoHandle` The default output handle is STDOUT
`int`	`inputHandle` The default input handle is STDIN
`static int`	`NULL` NULL output stream (bit bucket)
`static int`	`STDERR` STDERR stream generates outgoing data to both the STDOUT stream and to the `errors.log` file.
`static int`	`STDIN` STDIN stream handles incoming data from the console
`static int`	`STDOUT` STDOUT stream generates outgoing data to the console

Constructor Summary

Constructors
Constructor and Description

SerialInputStream()
Creates a serial connection

SerialInputStream(int hnd_in, int hnd_out)

Constructors
Constructor and Description
`SerialInputStream()` Creates a serial connection
`SerialInputStream(int hnd_in, int hnd_out)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`available()` Returns the number of bytes that can be read from this input stream without blocking.
`void`	`close()` close the port
`protected void`	`open()` open the port
`int`	`read()` Reads a character from the stream.
`void`	`setEcho(boolean echo)` Turns on and off echoing back characters read by this stream.

Methods inherited from class java.io.InputStream
mark, markSupported, read, read, reset, skip

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NULL
```
public static final int NULL
```
    NULL output stream (bit bucket)
    
    See Also:
    
    Constant Field Values
  - STDIN
```
public static final int STDIN
```
    STDIN stream handles incoming data from the console
    
    See Also:
    
    Constant Field Values
  - STDOUT
```
public static final int STDOUT
```
    STDOUT stream generates outgoing data to the console
    
    See Also:
    
    Constant Field Values
  - STDERR
```
public static final int STDERR
```
    STDERR stream generates outgoing data to both the STDOUT stream and to the errors.log file.
    
    See Also:
    
    Constant Field Values
  - COMIN
```
public static final int COMIN
```
    COMIN stream handles incoming data from the RS-232 port (COM)
    
    See Also:
    
    Constant Field Values
  - COMOUT
```
public static final int COMOUT
```
    COMOUT stream handles outgoing data to the RS-232 port (COM)
    
    See Also:
    
    Constant Field Values
  - AUXIN
```
public static final int AUXIN
```
    AUXIN stram handles incoming data from the AUX serial port
    
    See Also:
    
    Constant Field Values
  - AUXOUT
```
public static final int AUXOUT
```
    AUXOUT stram handles outgoing data to the AUX serial port
    
    See Also:
    
    Constant Field Values
  - inputHandle
```
public int inputHandle
```
    The default input handle is STDIN
  - echoHandle
```
public int echoHandle
```
    The default output handle is STDOUT
- Constructor Detail
  - SerialInputStream
```
public SerialInputStream()
```
    Creates a serial connection
  - SerialInputStream
```
public SerialInputStream(int hnd_in,
                         int hnd_out)
```
    Parameters:
    
    hnd_in - ?
    
    hnd_out - ?
- Method Detail
  - open
```
protected void open()
```
    open the port
  - close
```
public void close()
```
    close the port
    
    Overrides:
    
    close in class InputStream
  - read
```
public int read()
         throws IOException
```
    Reads a character from the stream. This method blocks for a timeout period and returns -1 on timeout.
    
    Specified by:
    
    read in class InputStream
    
    Returns:
    
    character read from the stream (-1 on timeout)
    
    Throws:
    
    IOException - on timeout
  - available
```
public int available()
```
    Returns the number of bytes that can be read from this input stream without blocking.
    
    Overrides:
    
    available in class InputStream
    
    Returns:
    
    count of bytes available
  - setEcho
```
public void setEcho(boolean echo)
```
    Turns on and off echoing back characters read by this stream.
    
    Parameters:
    
    echo - true if received data is to be echoed

Class SerialInputStream

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Field Detail

NULL

STDIN

STDOUT

STDERR

COMIN

COMOUT

AUXIN

AUXOUT

inputHandle

echoHandle

Constructor Detail

SerialInputStream

SerialInputStream

Method Detail

open

close

read

available

setEcho