me.legrange.swap

Interface SwapModem

All Known Implementing Classes:

SerialModem, TcpModem

public interface SwapModem

A virtual modem that provides access to a SWAP transport. Currently we implement two kinds, serial and TCP/IP.

Since:

1.0

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SwapModem.Type Type of SWAP modem.

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
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

Method Detail

open

void open()
   throws SwapException

connect to the modem.

Throws:

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

close

void close()
    throws SwapException

disconnect and close the modem

Throws:

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

isOpen

boolean isOpen()

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

Returns:

true if the modem is connected

send

void send(SwapMessage msg)
   throws SwapException

send a message out onto the network

Parameters:

msg - Message to send.

Throws:

SwapException - Thrown if there a a problem sending a message to the modem.

addListener

void addListener(MessageListener l)

add a message listener to receive messages

Parameters:

l - listener to add.

removeListener

void removeListener(MessageListener l)

remove a listener

Parameters:

l - listener to remove

getSetup

ModemSetup getSetup()
             throws SwapException

get the network setup

Returns:

The setup data

Throws:

SwapException - Thrown if there is a problem retrieving the setup

setSetup

void setSetup(ModemSetup setup)
       throws SwapException

set the network setup

Parameters:

setup - The modem setup to apply

Throws:

SwapException - Thrown if there is a problem applying the setup

getType

SwapModem.Type getType()

determine the type of virtual modem

Returns:

The type of the modem