usr.router

Class RouterController

java.lang.Object

usr.router.RouterController

All Implemented Interfaces:

java.lang.Runnable, ComponentController

public class RouterController
extends java.lang.Object
implements ComponentController, java.lang.Runnable

The Router Controller provides the management and control mechanisms for the whole router.

Each RouterController starts on a different port from any other RouterController, so that many can exist on the same host.

Constructor Summary

Constructors

Constructor and Description
RouterController(Router router, RouterOptions o, int mPort, int r2rPort, java.lang.String name) Construct a RouterController.
RouterController(Router router, RouterOptions o, int port, java.lang.String name) Construct a RouterController, given a specific port.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Collection<ApplicationHandle>	appList() List all App.
ApplicationResponse	appStart(java.lang.String commandstr) Start an App.
ApplicationResponse	appStop(java.lang.String commandstr) Stop an App.
boolean	canSetAddress() The address for the router can be set only if it has not been set before and the router has no connections
boolean	echo(Address addr) Try to echo to a router with a given Address
ApplicationHandle	findAppInfo(java.lang.String name) Get an ApplicationHandle for an Application.
NetIF	findNetIF(java.lang.String rName) Return the netIF associated with a certain router name
Address	getAddress() Get the router address.
int	getConnectionCount() Get the no of connections that have been made.
int	getConnectionPort() Get the port for the connection port
NetIFListener	getListener() Access the listener
NetIF	getLocalNetIF() Get the local NetIF that has the sockets.
cc.clayman.console.ManagementConsole	getManagementConsole() Get the ManagementConsole.
int	getManagementConsolePort() Get the port for the ManagementConsole.
java.lang.String	getName() Get the name of this RouterController.
RouterPort	getPort(int p) Get port N.
RoutingTable	getRoutingTable() Return a routing table as a string
NetIF	getTemporaryNetIFByID(int id) Find a NetIF by an id.
java.util.List<RouterPort>	listPorts() Get a list of all the ports with Network Interfaces.
int	newConnection() Increment the no of connections that have been made.
void	pauseMonitoring() Pause monitoring
boolean	ping(Address addr) Try to ping router with a given Address
RouterPort	plugTemporaryNetIFIntoPort(NetIF netIF) Plug a NetIF into the RouterFabric
boolean	readOptionsFile(java.lang.String fName) Read a file containing router options
boolean	readOptionsString(java.lang.String str) Read a string containing router options
void	removeNetIF(NetIF n) Remove a NetIF
void	resumeMonitoring() Resume monitoring
void	run() The main thread loop.
ApplicationResponse	runCommand(java.lang.String commandstr) run a particular command on a router
boolean	setAddress(Address addr) Set the router address.
void	setAP(int gid, int ap) Set the aggregation point for this router
boolean	setName(java.lang.String name) Set the name of this RouterController.
boolean	setNetIFWeight(java.lang.String rName, int weight) Set the netIF weight associated with a link to a certain router name
void	shutDown() Shut down the router from internal message from console -- pass the message up to the router object
boolean	start() Start me up.
void	startAP(int gid) This node starts as an AP
void	startMonitoring(java.net.InetSocketAddress addr, int when) Start monitoring.
boolean	stop() Stop the RouterController.
void	stopAP() This node stops as an AP
void	stopMonitoring() Stop monitoring.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouterController

public RouterController(Router router,
                RouterOptions o,
                int port,
                java.lang.String name)

Construct a RouterController, given a specific port. The ManagementConsole listens on 'port' and The Router to Router connections listens on port + 1.

RouterController

public RouterController(Router router,
                RouterOptions o,
                int mPort,
                int r2rPort,
                java.lang.String name)

Construct a RouterController. The ManagementConsole listens on 'mPort' and The Router to Router connections listens on 'r2rPort'.

Method Detail

getName

public java.lang.String getName()

Get the name of this RouterController.

Specified by:

getName in interface ComponentController

setName

public boolean setName(java.lang.String name)

Set the name of this RouterController. This can only be done before the Router has started to communicate with other elements.

Returns:

false if the name cannot be set

getAddress

public Address getAddress()

Get the router address. This is a special featrue for where the router has its own address.

setAddress

public boolean setAddress(Address addr)

Set the router address. This is a special feature where the router itself has its own address.

canSetAddress

public boolean canSetAddress()

The address for the router can be set only if it has not been set before and the router has no connections

getConnectionCount

public int getConnectionCount()

Get the no of connections that have been made.

newConnection

public int newConnection()

Increment the no of connections that have been made.

getManagementConsolePort

public int getManagementConsolePort()

Get the port for the ManagementConsole.

getConnectionPort

public int getConnectionPort()

Get the port for the connection port

getManagementConsole

public cc.clayman.console.ManagementConsole getManagementConsole()

Get the ManagementConsole.

Specified by:

getManagementConsole in interface ComponentController

start

public boolean start()

Start me up.

stop

public boolean stop()

Stop the RouterController.

shutDown

public void shutDown()

Shut down the router from internal message from console -- pass the message up to the router object

run

public void run()

The main thread loop. It processes asynchronous commands from the request queue.

Asynchronous commands include: CREATE_CONNECTION ip_addr/port - create a new network interface to a router on the address ip_addr/port

Specified by:

run in interface java.lang.Runnable

getRoutingTable

public RoutingTable getRoutingTable()

Return a routing table as a string

getTemporaryNetIFByID

public NetIF getTemporaryNetIFByID(int id)

Find a NetIF by an id.

plugTemporaryNetIFIntoPort

public RouterPort plugTemporaryNetIFIntoPort(NetIF netIF)

Plug a NetIF into the RouterFabric

appStart

public ApplicationResponse appStart(java.lang.String commandstr)

Start an App. It takes a class name and some args. It returns app_name ~= /Router-1/App/class.blah.Blah/1

appStop

public ApplicationResponse appStop(java.lang.String commandstr)

Stop an App. It takes an app name

appList

public java.util.Collection<ApplicationHandle> appList()

List all App. It takes an app name

findAppInfo

public ApplicationHandle findAppInfo(java.lang.String name)

Get an ApplicationHandle for an Application.

getListener

public NetIFListener getListener()

Access the listener

runCommand

public ApplicationResponse runCommand(java.lang.String commandstr)

run a particular command on a router

ping

public boolean ping(Address addr)

Try to ping router with a given Address

echo

public boolean echo(Address addr)

Try to echo to a router with a given Address

getLocalNetIF

public NetIF getLocalNetIF()

Get the local NetIF that has the sockets.

getPort

public RouterPort getPort(int p)

Get port N.

listPorts

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

Get a list of all the ports with Network Interfaces.

findNetIF

public NetIF findNetIF(java.lang.String rName)

Return the netIF associated with a certain router name

setNetIFWeight

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

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

removeNetIF

public void removeNetIF(NetIF n)

Remove a NetIF

readOptionsString

public boolean readOptionsString(java.lang.String str)

Read a string containing router options

readOptionsFile

public boolean readOptionsFile(java.lang.String fName)

Read a file containing router options

setAP

public void setAP(int gid,
         int ap)

Set the aggregation point for this router

startAP

public void startAP(int gid)

This node starts as an AP

stopAP

public void stopAP()

This node stops as an AP

startMonitoring

public void startMonitoring(java.net.InetSocketAddress addr,
                   int when)

Start monitoring. Sends to a particular UDP address, and sets the initial gap between transmits at every 'when' seconds.

pauseMonitoring

public void pauseMonitoring()

Pause monitoring

resumeMonitoring

public void resumeMonitoring()

Resume monitoring

stopMonitoring

public void stopMonitoring()

Stop monitoring.