me.legrange.swap

Class SerialModem

java.lang.Object

me.legrange.swap.SerialModem

All Implemented Interfaces:

SwapModem

public final class SerialModem
extends Object
implements SwapModem

An interface providing access through the serial port to the SWAP modem.

Since:

1.0

Author:

Gideon le Grange https://github.com/GideonLeGrange *

Nested Class Summary

Nested classes/interfaces inherited from interface me.legrange.swap.SwapModem

SwapModem.Type

Constructor Summary

Constructors

Constructor and Description
SerialModem(String port, int baud)

Method Summary

Modifier and Type	Method and Description
void	addListener(MessageListener l) add a message listener to receive messages
void	close() disconnect and close the modem
int	getBaud() Get the serial speed this modem connects at
String	getPort() Get the name of the serial port used by this modem.
ModemSetup	getSetup() get the network setup
SwapModem.Type	getType() determine the type of virtual modem
boolean	isOpen() Check if the modem is open (connected to it's implementation device)
void	open() connect to the modem.
void	removeListener(MessageListener l) remove a listener
void	send(SwapMessage msg) send a message out onto the network
void	setSetup(ModemSetup setup) set the network setup

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialModem

public SerialModem(String port,
                   int baud)

Method Detail

open

public void open()
          throws SwapException

Description copied from interface: SwapModem

connect to the modem.

Specified by:

open in interface SwapModem

Throws:

SwapException - Thrown if there is a problem opening the modem.

close

public void close()
           throws SerialException

Description copied from interface: SwapModem

disconnect and close the modem

Specified by:

close in interface SwapModem

Throws:

SerialException

isOpen

public boolean isOpen()

Description copied from interface: SwapModem

Check if the modem is open (connected to it's implementation device)

Specified by:

isOpen in interface SwapModem

Returns:

true if the modem is connected

send

public void send(SwapMessage msg)
          throws SerialException

Description copied from interface: SwapModem

send a message out onto the network

Specified by:

send in interface SwapModem

Parameters:

msg - Message to send.

Throws:

SerialException

addListener

public void addListener(MessageListener l)

Description copied from interface: SwapModem

add a message listener to receive messages

Specified by:

addListener in interface SwapModem

Parameters:

l - listener to add.

removeListener

public void removeListener(MessageListener l)

Description copied from interface: SwapModem

remove a listener

Specified by:

removeListener in interface SwapModem

Parameters:

l - listener to remove

getSetup

public ModemSetup getSetup()
                    throws SerialException

Description copied from interface: SwapModem

get the network setup

Specified by:

getSetup in interface SwapModem

Returns:

The setup data

Throws:

SerialException

setSetup

public void setSetup(ModemSetup setup)
              throws SerialException

Description copied from interface: SwapModem

set the network setup

Specified by:

setSetup in interface SwapModem

Parameters:

setup - The modem setup to apply

Throws:

SerialException

getType

public SwapModem.Type getType()

Description copied from interface: SwapModem

determine the type of virtual modem

Specified by:

getType in interface SwapModem

Returns:

The type of the modem

getPort

public String getPort()

Get the name of the serial port used by this modem.

Returns:

The name of the serial port

getBaud

public int getBaud()

Get the serial speed this modem connects at

Returns:

The serial speed