com.sun.squawk.io.j2me.serial
Class Protocol

java.lang.Object
  com.sun.squawk.io.ConnectionBase
      com.sun.squawk.io.j2me.serial.Protocol

All Implemented Interfaces:

Connection, InputConnection, OutputConnection, StreamConnection

public class Protocol
extends ConnectionBase
implements StreamConnection

serial.Protocol - provides read access to the serial/USB port for an eSPOT

This protocol understands only three URLs: "serial://usb", "serial://usart" and "serial://". The first two refer to connections to the USB and USART respectively. The first is known as the "default" connection and refers to a combination which will be the USB if the SPOT has been connected to a host computer and enumerated, otherwise the USART. This "default" connection is the one normally used for System.out and System.err traffic. By assigning System.out and System.err to a specific url, it is possible to use one connection for System.out and System.err and the other for a specific application purpose.

Note that in the case where the URL is "serial://usart" it is possible to append parameters to control the serial port settings. For example:

"serial://usart?baudrate=115200&databits=8&parity=even&stopbits=0"

Allowed values for parity are even, odd, mark and none.

Field Summary

static int	US_BRGR
static int	US_MR
static int	USART0_BASE_ADDRESS
static int	USART1_BASE_ADDRESS

Constructor Summary

Protocol()

Method Summary

void	close() Close
Connection	open(String protocol, String name, int mode, boolean timeouts) Open a connection to a target.
InputStream	openInputStream() Open and return a data input stream for a connection.
OutputStream	openOutputStream() Open and return a data output stream for a connection.
static void	setResourceRegistry(IResourceRegistry resourceRegistry) This method is provided for test purposes only.

Methods inherited from class com.sun.squawk.io.ConnectionBase

openDataInputStream, openDataOutputStream

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.microedition.io.InputConnection

openDataInputStream

Methods inherited from interface javax.microedition.io.OutputConnection

openDataOutputStream

Field Detail

USART0_BASE_ADDRESS

public static final int USART0_BASE_ADDRESS

See Also:

Constant Field Values

USART1_BASE_ADDRESS

public static final int USART1_BASE_ADDRESS

See Also:

Constant Field Values

US_BRGR

public static final int US_BRGR

See Also:

Constant Field Values

US_MR

public static final int US_MR

See Also:

Constant Field Values

Constructor Detail

Protocol

public Protocol()

Method Detail

setResourceRegistry

public static void setResourceRegistry(IResourceRegistry resourceRegistry)

This method is provided for test purposes only. It should not be used by normal applications.

Parameters:

resourceRegistry -

open

public Connection open(String protocol,
                       String name,
                       int mode,
                       boolean timeouts)
                throws IOException

Description copied from class: ConnectionBase

Open a connection to a target.

Specified by:

open in class ConnectionBase

Parameters:

protocol - The URL protocol

name - The URL for the connection

mode - The access mode

timeouts - A flag to indicate that the caller wants timeout exceptions

Returns:

A new Connection object

Throws:

IOException - If some other kind of I/O error occurs.

close

public void close()
           throws IOException

Description copied from class: ConnectionBase

Close

Specified by:

close in interface Connection

Overrides:

close in class ConnectionBase

Throws:

IOException - If an I/O error occurs

openInputStream

public InputStream openInputStream()
                            throws IOException

Description copied from class: ConnectionBase

Open and return a data input stream for a connection.

Specified by:

openInputStream in interface InputConnection

Overrides:

openInputStream in class ConnectionBase

Returns:

An input stream

Throws:

IOException - If an I/O error occurs

openOutputStream

public OutputStream openOutputStream()
                              throws IOException

Description copied from class: ConnectionBase

Open and return a data output stream for a connection.

Specified by:

openOutputStream in interface OutputConnection

Overrides:

openOutputStream in class ConnectionBase

Returns:

An input stream

Throws:

IOException - If an I/O error occurs