usr.router

Class AbstractRouterFabric

java.lang.Object

usr.router.AbstractRouterFabric

All Implemented Interfaces:

DatagramDevice, NetIFListener, RouterFabric

Direct Known Subclasses:

SimpleRouterFabric, VectorRouterFabric

public abstract class AbstractRouterFabric
extends java.lang.Object
implements RouterFabric, NetIFListener, DatagramDevice

The main abstract code for a RouterFabric within UserSpaceRouting.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRouterFabric(Router r, RouterOptions opt) Construct a AbstractRouterFabric.

Method Summary

Methods

Modifier and Type	Method and Description
RouterPort	addNetIF(NetIF netIF) Add a Network Interface to this Router.
void	closedDevice(DatagramDevice dd) A datagram device has closed and must be removed
void	closePort(RouterPort port) Close port.
void	closePorts() Close ports.
boolean	doRemove(NetIF netIF, boolean remote) Do work for remote or normal remove -- onyl difference is in sending control close
boolean	echo(Address addr) Echo command received
boolean	echo(Address dst, int port) Echo command received
boolean	enqueueDatagram(Datagram dg) forward a datagram (does not set src address)
NetIF	findNetIF(java.lang.String name) Find the netIF which connects to a given end host or a connection name
Address	getAddress() Get the Address for this connection.
FabricDevice	getFabricDevice() Get the FabricDevice associated with Net Device
NetIF	getLocalNetIF() Get the local NetIF that has the sockets.
java.lang.String	getName() Get it's name
NetIFListener	getNetIFListener() Get the Listener of a NetIF.
RouterPort	getPort(int p) Get port N.
DatagramDevice	getRoute(Datagram dg) Return either the NetIF for the datagram or failing this null to indicate unroutable or datagram is for router
FabricDevice	getRouteFabric(Datagram dg) Get the Fabric Device which this packet should be sent to
Router	getRouter() Get the Router this Fabric is part of
RoutingTable	getRoutingTable() Return the routing table
boolean	init() Initialisation
java.util.List<NetIF>	listNetIF() Get a list of all connected Network Interfaces
java.util.List<RouterPort>	listPorts() Get a list of all the ports with Network Interfaces.
boolean	ourAddress(Address addr) Is this datagram for us
boolean	outQueueHandler(Datagram datagram, DatagramDevice device) Datagram which has arrived is ours
boolean	ping(Address dst) Ping command received
void	remoteClosePort(RouterPort port) Close port.
boolean	remoteRemoveNetIF(NetIF netIF) Remove a Network Interface from this Router after remote request synchronized to prevent multiple calls
boolean	removeNetIF(NetIF netIF) Remove a Network Interface from this Router.
boolean	sendDatagram(Datagram dg) Send a Datagram originating at this host (sets src address) and
void	sendGoodbye() Send goodbye message to all ports
void	setAddress(Address a) Set the Address for this connection.
void	setName(java.lang.String n) Set the name of this Net Device
void	setNetIFListener(NetIFListener l) Set the Listener of NetIF.
boolean	setNetIFWeight(java.lang.String name, int weight) Set the netIF weight associated with a link to a certain router name
boolean	start() Start me up.
boolean	stop() Stop the RouterFabric.
void	TTLDrop(Datagram dg) Return a TTL expired datagram unless this is a TTL expired datagram
void	withdrawToOtherInterfaces(java.util.ArrayList<Address> addr, NetIF netIF) Send a withdrawal message for a given address to all interfaces on this network interface

Methods inherited from class java.lang.Object

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

Methods inherited from interface usr.router.RouterFabric

decodeRoutingTable, newRoutingTable

Constructor Detail

AbstractRouterFabric

protected AbstractRouterFabric(Router r,
                    RouterOptions opt)

Construct a AbstractRouterFabric.

Method Detail

init

public boolean init()

Initialisation

Specified by:

init in interface RouterFabric

start

public boolean start()

Start me up.

Specified by:

start in interface RouterFabric

stop

public boolean stop()

Stop the RouterFabric.

Specified by:

stop in interface RouterFabric

getRouter

public Router getRouter()

Get the Router this Fabric is part of

Specified by:

getRouter in interface RouterFabric

getLocalNetIF

public NetIF getLocalNetIF()

Get the local NetIF that has the sockets.

Specified by:

getLocalNetIF in interface RouterFabric

getPort

public RouterPort getPort(int p)

Get port N.

Specified by:

getPort in interface RouterFabric

listPorts

public java.util.List<RouterPort> listPorts()

Get a list of all the ports with Network Interfaces.

Specified by:

listPorts in interface RouterFabric

closePorts

public void closePorts()

Close ports.

Specified by:

closePorts in interface RouterFabric

closePort

public void closePort(RouterPort port)

Close port.

Specified by:

closePort in interface RouterFabric

remoteClosePort

public void remoteClosePort(RouterPort port)

Close port.

ourAddress

public boolean ourAddress(Address addr)

Is this datagram for us

Specified by:

ourAddress in interface NetIFListener

getRoute

public DatagramDevice getRoute(Datagram dg)
                        throws java.net.NoRouteToHostException

Return either the NetIF for the datagram or failing this null to indicate unroutable or datagram is for router

Throws:

java.net.NoRouteToHostException

getRouteFabric

public FabricDevice getRouteFabric(Datagram dg)
                            throws java.net.NoRouteToHostException

Get the Fabric Device which this packet should be sent to

Specified by:

getRouteFabric in interface NetIFListener

Throws:

java.net.NoRouteToHostException

TTLDrop

public void TTLDrop(Datagram dg)

Return a TTL expired datagram unless this is a TTL expired datagram

Specified by:

TTLDrop in interface NetIFListener

outQueueHandler

public boolean outQueueHandler(Datagram datagram,
                      DatagramDevice device)

Datagram which has arrived is ours

Specified by:

outQueueHandler in interface DatagramDevice

sendGoodbye

public void sendGoodbye()

Description copied from interface: RouterFabric

Send goodbye message to all ports

Specified by:

sendGoodbye in interface RouterFabric

withdrawToOtherInterfaces

public void withdrawToOtherInterfaces(java.util.ArrayList<Address> addr,
                             NetIF netIF)

Send a withdrawal message for a given address to all interfaces on this network interface

getRoutingTable

public RoutingTable getRoutingTable()

Return the routing table

Specified by:

getRoutingTable in interface RouterFabric

findNetIF

public NetIF findNetIF(java.lang.String name)

Find the netIF which connects to a given end host or a connection name

Specified by:

findNetIF in interface RouterFabric

Returns:

null if none exists

setNetIFWeight

public boolean setNetIFWeight(java.lang.String name,
                     int weight)

Set the netIF weight associated with a link to a certain router name

Specified by:

setNetIFWeight in interface RouterFabric

setNetIFListener

public void setNetIFListener(NetIFListener l)

Description copied from interface: DatagramDevice

Set the Listener of NetIF.

Specified by:

setNetIFListener in interface DatagramDevice

getNetIFListener

public NetIFListener getNetIFListener()

Description copied from interface: DatagramDevice

Get the Listener of a NetIF.

Specified by:

getNetIFListener in interface DatagramDevice

listNetIF

public java.util.List<NetIF> listNetIF()

Get a list of all connected Network Interfaces

Specified by:

listNetIF in interface RouterFabric

ping

public boolean ping(Address dst)

Ping command received

Specified by:

ping in interface RouterFabric

getAddress

public Address getAddress()

Description copied from interface: DatagramDevice

Get the Address for this connection.

Specified by:

getAddress in interface DatagramDevice

setAddress

public void setAddress(Address a)

Description copied from interface: DatagramDevice

Set the Address for this connection.

Specified by:

setAddress in interface DatagramDevice

getName

public java.lang.String getName()

Description copied from interface: NetIFListener

Get it's name

Specified by:

getName in interface DatagramDevice

Specified by:

getName in interface NetIFListener

setName

public void setName(java.lang.String n)

Description copied from interface: DatagramDevice

Set the name of this Net Device

Specified by:

setName in interface DatagramDevice

getFabricDevice

public FabricDevice getFabricDevice()

Description copied from interface: DatagramDevice

Get the FabricDevice associated with Net Device

Specified by:

getFabricDevice in interface DatagramDevice

sendDatagram

public boolean sendDatagram(Datagram dg)
                     throws java.net.NoRouteToHostException

Description copied from interface: DatagramDevice

Send a Datagram originating at this host (sets src address) and

Specified by:

sendDatagram in interface DatagramDevice

Throws:

java.net.NoRouteToHostException

enqueueDatagram

public boolean enqueueDatagram(Datagram dg)
                        throws java.net.NoRouteToHostException

Description copied from interface: DatagramDevice

forward a datagram (does not set src address)

Specified by:

enqueueDatagram in interface DatagramDevice

Throws:

java.net.NoRouteToHostException

echo

public boolean echo(Address addr)

Echo command received

Specified by:

echo in interface RouterFabric

echo

public boolean echo(Address dst,
           int port)

Echo command received

addNetIF

public RouterPort addNetIF(NetIF netIF)

Add a Network Interface to this Router.

Specified by:

addNetIF in interface RouterFabric

removeNetIF

public boolean removeNetIF(NetIF netIF)

Remove a Network Interface from this Router. synchronized to prevent multiple calls

Specified by:

removeNetIF in interface RouterFabric

remoteRemoveNetIF

public boolean remoteRemoveNetIF(NetIF netIF)

Remove a Network Interface from this Router after remote request synchronized to prevent multiple calls

doRemove

public boolean doRemove(NetIF netIF,
               boolean remote)

Do work for remote or normal remove -- onyl difference is in sending control close

closedDevice

public void closedDevice(DatagramDevice dd)

Description copied from interface: NetIFListener

A datagram device has closed and must be removed

Specified by:

closedDevice in interface NetIFListener