org.lsst.ccs.drivers.ascii

Class Session

java.lang.Object

org.lsst.ccs.drivers.ascii.Session

public class Session
extends Object

Driver for managing an interactive Telnet or Ascii session

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Session.ConnType Public constants.

Field Summary

Fields

Modifier and Type	Field and Description
static int	OPTN_KEEP_ALIVE

Constructor Summary

Constructors

Constructor and Description
Session(int options, String sessnPrompt, String unamePrompt, String passwdPrompt, String exitCommand, Ascii.Terminator terminator) Constructor

Method Summary

Modifier and Type	Method and Description
static void	checkReplyLength(String[] reply, int count) Checks whether a reply size is valid
void	close() Closes the connection
String	getPrompt() Gets the prompt
boolean	isOpen() Tests whether the device connection is open.
void	open(Session.ConnType connType, String ident, int baudRate, int runTimeout) Opens a connection.
void	open(Session.ConnType connType, String ident, int baudRate, String username, String password, int logTimeout, int runTimeout) Opens a connection and logs in.
String[]	receive() Receives a response
String[]	receive(String command) Sends a command and receives the response
static void	responseError(String resp) Generates an invalid response exception
void	send(String command) Sends a command
void	setCharTimeout(int timeout) Sets the response inter-character timeout.
void	setConnTimeout(int timeout) Sets the network connection timeout.
void	setDebug(boolean on) Sets the debug option.
void	setTimeout(int timeout) Sets the response timeout.

Methods inherited from class java.lang.Object

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

Field Detail

OPTN_KEEP_ALIVE

public static final int OPTN_KEEP_ALIVE

See Also:

Constant Field Values

Constructor Detail

Session

public Session(int options,
               String sessnPrompt,
               String unamePrompt,
               String passwdPrompt,
               String exitCommand,
               Ascii.Terminator terminator)

Constructor

Parameters:

options - Options word

sessnPrompt - The expected session prompt

unamePrompt - The expected username prompt

passwdPrompt - The expected password prompt

exitCommand - The exit command

terminator - The Ascii command/response terminator

Method Detail

open

public void open(Session.ConnType connType,
                 String ident,
                 int baudRate,
                 String username,
                 String password,
                 int logTimeout,
                 int runTimeout)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection and logs in.

Parameters:

connType - The enumerated connection type: TELNET, FTDI or SERIAL

ident - The host name (TELNET), USB ID (FTDI) or port name (SERIAL)

baudRate - The baud rate for FTDI and Serial

username - The user name

password - The password

logTimeout - The character timeout when logging in (msec)

runTimeout - The character timeout when running (msec)

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(Session.ConnType connType,
                 String ident,
                 int baudRate,
                 int runTimeout)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection.

Parameters:

connType - The enumerated connection type: FTDI or SERIAL

ident - The USB ID (FTDI) or port name (SERIAL)

baudRate - The baud rate for FTDI and Serial

runTimeout - The character timeout when running (msec)

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

public void close()
           throws org.lsst.ccs.drivers.commons.DriverException

Closes the connection

Throws:

org.lsst.ccs.drivers.commons.DriverException

isOpen

public boolean isOpen()

Tests whether the device connection is open.

Returns:

Whether or not the connection is open

send

public void send(String command)
          throws org.lsst.ccs.drivers.commons.DriverException

Sends a command

Parameters:

command - The command to send

Throws:

org.lsst.ccs.drivers.commons.DriverException

receive

public String[] receive()
                 throws org.lsst.ccs.drivers.commons.DriverException

Receives a response

Returns:

An array of strings each of which is a line of the response. The first element is the echoed command.

Throws:

org.lsst.ccs.drivers.commons.DriverException

receive

public String[] receive(String command)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sends a command and receives the response

Parameters:

command - The command to send

Returns:

An array of strings each of which is a line of the response. The first element is the echoed command.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setConnTimeout

public void setConnTimeout(int timeout)

Sets the network connection timeout.

Parameters:

timeout - The timeout (ms). 0 means no timeout.

setTimeout

public void setTimeout(int timeout)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the response timeout.

Parameters:

timeout - The timeout (ms)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCharTimeout

public void setCharTimeout(int timeout)
                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the response inter-character timeout.

Parameters:

timeout - The timeout (ms)

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPrompt

public String getPrompt()

Gets the prompt

Returns:

The saved prompt

setDebug

public void setDebug(boolean on)

Sets the debug option.

Parameters:

on - Whether to turn debugging on

checkReplyLength

public static void checkReplyLength(String[] reply,
                                    int count)
                             throws org.lsst.ccs.drivers.commons.DriverException

Checks whether a reply size is valid

Parameters:

reply - The array of reply lines

count - The expected line count

Throws:

org.lsst.ccs.drivers.commons.DriverException - if unequal

responseError

public static void responseError(String resp)
                          throws org.lsst.ccs.drivers.commons.DriverException

Generates an invalid response exception

Parameters:

resp - The response string

Throws:

org.lsst.ccs.drivers.commons.DriverException - always