usr.globalcontroller

Class GlobalController

java.lang.Object

usr.globalcontroller.GlobalController

All Implemented Interfaces:

ComponentController

Direct Known Subclasses:

VimNem

public class GlobalController
extends java.lang.Object
implements ComponentController

The GlobalController is in overall control of the software. It contacts LocalControllers to set up virtual routers and then gives set up and tear down instructions directly to them.

Constructor Summary

Constructors

Constructor and Description
GlobalController() Construct a GlobalController -- this constructor contains things which apply whether we are simulation or emulation

Method Summary

Methods

Modifier and Type	Method and Description
void	aliveMessage(LocalHostInfo lh) An alive message has been received from the host specified in LocalHostInfo.
void	APControllerUpdate(long time)
int	appStart(int routerID, java.lang.String className, java.lang.String[] args) Run an application on a Router.
int	appStop(int routerID, int appID) Stop an application on a Router.
void	apSet(int gid, int AP) Set the agg point for router gid to router AP
void	checkIsolated(long time) Check network for isolated nodes and connect them if possible
void	checkIsolated(long time, int gid) Check if given node is isolated and connect it if possible
void	checkTrafficOutputRequests(long time, OutputType o) When output for traffic is requested then queue requests for traffic from routers
java.util.List<java.lang.String>	compileRouterStats() Get the router stats -- method is blocking
void	connectNetwork(long time) Make sure network is connected
void	connectNetwork(long time, int r1, int r2) Make sure network is connected from r1 to r2
java.lang.String	elapsedToString(long elapsedTime) Convert an elasped time, in milliseconds, into a string.
int	endLink(long time, int router1Id, int router2Id) Event to unlink two routers
int	endRouter(long time, int routerId) Event to end a router
BasicRouterInfo	findAppInfo(int appId) Find some app info
us.monoid.json.JSONObject	findAppInfoAsJSON(int appID) Find some app info, given an app ID and returns a JSONObject.
eu.reservoir.monitoring.core.Reporter	findByInterface(java.lang.Class inter) Find reporter by Interface Class
eu.reservoir.monitoring.core.Reporter	findByLabel(java.lang.String label) Find reporter by label
LinkInfo	findLinkInfo(int linkID) Find link info
us.monoid.json.JSONObject	findLinkInfoAsJSON(int linkID) Find link info and return a JSONObject
java.util.Collection<LinkInfo>	findLinkInfoByRouter(int routerID) Find links for Router.
BasicRouterInfo	findRouterInfo(int rId) Find some router info
BasicRouterInfo	findRouterInfo(java.lang.String value) Find some router info, given a router address or a router name
us.monoid.json.JSONObject	findRouterInfoAsJSON(int routerID) Find some router info, given a router address or a router name and return a JSONObject
void	followEvent(SimEvent e, EventScheduler s, GlobalController g, java.lang.Object o) Add or remove events following a simulation event -- object allows global controller to pass extra parameters related to event if necessary
void	gcFollowEvent(SimEvent e, java.lang.Object o) Follow an event not generated by engine
void	gcPreceedEvent(SimEvent e) Preceed an event not generated by engine
java.util.Collection<LinkInfo>	getAllLinkInfo() List all LinkInfo
us.monoid.json.JSONObject	getAllLinkInfoAsJSON(java.lang.String detail) List all LinkInfo as a JSONObject
java.util.Collection<BasicRouterInfo>	getAllRouterInfo() List all RouterInfo.
us.monoid.json.JSONObject	getAllRouterInfoAsJSON(java.lang.String detail) List all RouterInfo as a JSON object
int	getAP(int gid) Get the nominated AP for a router
APController	getAPController() Get the APController
java.util.ArrayList<java.lang.Integer>	getAPs() List all APs
long	getEventTime() Get the time of the current event
int[]	getLinkCosts(int routerId)
int	getLinkCount() Get the number of links
int	getLinkWeight(int l1, int l2)
LocalHostInfo	getLocalHostInfo() Get the host info for this GlobalController.
cc.clayman.console.ManagementConsole	getManagementConsole() Get the ManagementConsole this ComponentController interacts with.
int	getMaxRouterId() Accessor function for maxRouterId_
java.lang.String	getName() Get the name of this GlobalController.
int	getNoRouters() Number of routers in simulation
ControlOptions	getOptions() Accessor function for ControlOptions structure options_
int[]	getOutLinks(int routerId)
int	getPort() Get the port for this GlobalController
java.util.List<eu.reservoir.monitoring.core.Reporter>	getReporterList() Get the Reporter list of the monitoring data
int	getRouterCount() Get the number of routers
int	getRouterId(int i) Return id of ith router
us.monoid.json.JSONObject	getRouterLinkStatsAsJSON(int routerID) Get router stats info, given a router address and return a JSONObject
us.monoid.json.JSONObject	getRouterLinkStatsAsJSON(int routerID, int dstID) Get router stats info, given a router address and a destination router and return a JSONObject
java.util.ArrayList<java.lang.Integer>	getRouterList() Accessor function for routerList
java.lang.String	getRouterStats() Accessor function for routerStats_
java.util.ArrayList<BasicRouterInfo>	getShutdownRouters() List all shutdown routers
long	getSimulationCurrentTime() Get the simulation current time.
long	getSimulationElapsedTime() Get the simulation elapsed time.
long	getSimulationStartTime() Get the simulation start time.
long	getStartTime() Get the simulation start time.
java.util.HashMap<java.lang.String,int[]>	getTrafficLinkCounts()
protected void	informAllLinks() Called to give a snapshot of all the links
protected void	informAllRouters() Called to give a snapshot of all the routers
protected void	informRouterEnded(us.monoid.json.JSONObject routerAttrs) Called after a router is ended.
protected void	informRouterStarted(us.monoid.json.JSONObject routerAttrs) Called after a router is started.
protected boolean	init() Basic intialisation for the global controller
boolean	isConnected(int routerId, int other) Is a router directly connected to another one
boolean	isLatticeMonitoring()
boolean	isValidAppID(int appId) Is the app ID valid.
boolean	isValidLinkID(int lId) Is the link ID valid.
boolean	isValidRouterID(int rId) Is the router ID valid.
us.monoid.json.JSONObject	listShutdownRoutersAsJSON() List all shutdown routers
static void	main(java.lang.String[] args) Main entry point.
int	onRouter(int routerID, java.lang.String className, java.lang.String[] args) Run an application on a Router.
void	preceedEvent(SimEvent e, EventScheduler s, GlobalController g) Add or remove events following a simulation event
void	receiveRouterStats(java.lang.String stats) Receiver router traffic -- if it completes a set then output it
boolean	reportAP(int gid, int AP) Router GID reports a connection to access point AP
void	requestRouterStats() Request router stats
void	setAP(int gid, int AP) Set the agg point for router gid to router AP
void	setLinkCosts(int routerId, int[] costs)
int	setLinkWeight(long time, int router1Id, int router2Id, int weight) Update the link weight between two routers.
void	setListenPort() Set the port of the GlobalController
void	setOutLinks(int routerId, int[] out)
void	setStartupFile(java.lang.String file) Set the startup file
protected int	setupListenPort() Setup the port for this GlobalController
protected void	shutDown()
void	shutDownCommand() Shutdown called from console -- add shut down command to list to happen now
void	start()
protected void	startConsole() Start the console.
int	startLink(long time, int router1Id, int router2Id, int weight, java.lang.String name) Create a link between two routers.
void	startMonitoringConsumer(java.net.InetSocketAddress addr) Start listening for router stats using monitoring framework.
void	startMonitoringProducer(java.net.InetSocketAddress addr) Start producing router stats using monitoring framework.
int	startRouter(long time, java.lang.String address, java.lang.String name) Event to start a router
protected void	stopConsole() Stop the console.
void	stopMonitoringConsumer() Stop monitoring.
void	stopMonitoringProducer() Stop monitoring Producer.
void	waitUntil(long time) Wait until a specified absolute time is milliseconds.
void	wakeWait() Interrupt above wait

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalController

public GlobalController()

Construct a GlobalController -- this constructor contains things which apply whether we are simulation or emulation

Method Detail

main

public static void main(java.lang.String[] args)

Main entry point.

init

protected boolean init()

Basic intialisation for the global controller

start

public void start()

startConsole

protected void startConsole()

Start the console.

stopConsole

protected void stopConsole()

Stop the console.

startRouter

public int startRouter(long time,
              java.lang.String address,
              java.lang.String name)

Event to start a router

endRouter

public int endRouter(long time,
            int routerId)

Event to end a router

informRouterStarted

protected void informRouterStarted(us.monoid.json.JSONObject routerAttrs)
                            throws us.monoid.json.JSONException

Called after a router is started.

Throws:

us.monoid.json.JSONException

informRouterEnded

protected void informRouterEnded(us.monoid.json.JSONObject routerAttrs)
                          throws us.monoid.json.JSONException

Called after a router is ended.

Throws:

us.monoid.json.JSONException

informAllRouters

protected void informAllRouters()

Called to give a snapshot of all the routers

informAllLinks

protected void informAllLinks()

Called to give a snapshot of all the links

findRouterInfo

public BasicRouterInfo findRouterInfo(int rId)

Find some router info

findRouterInfo

public BasicRouterInfo findRouterInfo(java.lang.String value)

Find some router info, given a router address or a router name

findRouterInfoAsJSON

public us.monoid.json.JSONObject findRouterInfoAsJSON(int routerID)
                                               throws us.monoid.json.JSONException

Find some router info, given a router address or a router name and return a JSONObject

Throws:

us.monoid.json.JSONException

getAllRouterInfo

public java.util.Collection<BasicRouterInfo> getAllRouterInfo()

List all RouterInfo.

getAllRouterInfoAsJSON

public us.monoid.json.JSONObject getAllRouterInfoAsJSON(java.lang.String detail)
                                                 throws us.monoid.json.JSONException

List all RouterInfo as a JSON object

Throws:

us.monoid.json.JSONException

getRouterCount

public int getRouterCount()

Get the number of routers

isValidRouterID

public boolean isValidRouterID(int rId)

Is the router ID valid.

getShutdownRouters

public java.util.ArrayList<BasicRouterInfo> getShutdownRouters()

List all shutdown routers

listShutdownRoutersAsJSON

public us.monoid.json.JSONObject listShutdownRoutersAsJSON()
                                                    throws us.monoid.json.JSONException

List all shutdown routers

Throws:

us.monoid.json.JSONException

findLinkInfo

public LinkInfo findLinkInfo(int linkID)

Find link info

findLinkInfoAsJSON

public us.monoid.json.JSONObject findLinkInfoAsJSON(int linkID)
                                             throws us.monoid.json.JSONException

Find link info and return a JSONObject

Throws:

us.monoid.json.JSONException

getAllLinkInfo

public java.util.Collection<LinkInfo> getAllLinkInfo()

List all LinkInfo

getAllLinkInfoAsJSON

public us.monoid.json.JSONObject getAllLinkInfoAsJSON(java.lang.String detail)
                                               throws us.monoid.json.JSONException

List all LinkInfo as a JSONObject

Throws:

us.monoid.json.JSONException

isValidLinkID

public boolean isValidLinkID(int lId)

Is the link ID valid.

findLinkInfoByRouter

public java.util.Collection<LinkInfo> findLinkInfoByRouter(int routerID)

Find links for Router.

getRouterLinkStatsAsJSON

public us.monoid.json.JSONObject getRouterLinkStatsAsJSON(int routerID)
                                                   throws us.monoid.json.JSONException

Get router stats info, given a router address and return a JSONObject

Throws:

us.monoid.json.JSONException

getRouterLinkStatsAsJSON

public us.monoid.json.JSONObject getRouterLinkStatsAsJSON(int routerID,
                                                 int dstID)
                                                   throws us.monoid.json.JSONException

Get router stats info, given a router address and a destination router and return a JSONObject

Throws:

us.monoid.json.JSONException

startLink

public int startLink(long time,
            int router1Id,
            int router2Id,
            int weight,
            java.lang.String name)

Create a link between two routers. Pass in weight and link name.

getOutLinks

public int[] getOutLinks(int routerId)

setOutLinks

public void setOutLinks(int routerId,
               int[] out)

getLinkCount

public int getLinkCount()

Get the number of links

isConnected

public boolean isConnected(int routerId,
                  int other)

Is a router directly connected to another one

getLinkCosts

public int[] getLinkCosts(int routerId)

setLinkCosts

public void setLinkCosts(int routerId,
                int[] costs)

endLink

public int endLink(long time,
          int router1Id,
          int router2Id)

Event to unlink two routers

setLinkWeight

public int setLinkWeight(long time,
                int router1Id,
                int router2Id,
                int weight)

Update the link weight between two routers. Pass in weight.

findAppInfo

public BasicRouterInfo findAppInfo(int appId)

Find some app info

findAppInfoAsJSON

public us.monoid.json.JSONObject findAppInfoAsJSON(int appID)
                                            throws us.monoid.json.JSONException

Find some app info, given an app ID and returns a JSONObject.

Throws:

us.monoid.json.JSONException

isValidAppID

public boolean isValidAppID(int appId)

Is the app ID valid.

onRouter

public int onRouter(int routerID,
           java.lang.String className,
           java.lang.String[] args)

Run an application on a Router. Returns the app ID

appStart

public int appStart(int routerID,
           java.lang.String className,
           java.lang.String[] args)

Run an application on a Router. Returns the app ID

appStop

public int appStop(int routerID,
          int appID)

Stop an application on a Router. Takes the router ID and the appID Returns int

requestRouterStats

public void requestRouterStats()

Request router stats

compileRouterStats

public java.util.List<java.lang.String> compileRouterStats()

Get the router stats -- method is blocking

shutDownCommand

public void shutDownCommand()

Shutdown called from console -- add shut down command to list to happen now

shutDown

protected void shutDown()

APControllerUpdate

public void APControllerUpdate(long time)

getTrafficLinkCounts

public java.util.HashMap<java.lang.String,int[]> getTrafficLinkCounts()

checkTrafficOutputRequests

public void checkTrafficOutputRequests(long time,
                              OutputType o)

When output for traffic is requested then queue requests for traffic from routers

receiveRouterStats

public void receiveRouterStats(java.lang.String stats)

Receiver router traffic -- if it completes a set then output it

getRouterStats

public java.lang.String getRouterStats()

Accessor function for routerStats_

startMonitoringConsumer

public void startMonitoringConsumer(java.net.InetSocketAddress addr)

Start listening for router stats using monitoring framework.

stopMonitoringConsumer

public void stopMonitoringConsumer()

Stop monitoring.

startMonitoringProducer

public void startMonitoringProducer(java.net.InetSocketAddress addr)

Start producing router stats using monitoring framework.

stopMonitoringProducer

public void stopMonitoringProducer()

Stop monitoring Producer.

getReporterList

public java.util.List<eu.reservoir.monitoring.core.Reporter> getReporterList()

Get the Reporter list of the monitoring data

findByLabel

public eu.reservoir.monitoring.core.Reporter findByLabel(java.lang.String label)

Find reporter by label

findByInterface

public eu.reservoir.monitoring.core.Reporter findByInterface(java.lang.Class inter)

Find reporter by Interface Class

aliveMessage

public void aliveMessage(LocalHostInfo lh)

An alive message has been received from the host specified in LocalHostInfo.

waitUntil

public void waitUntil(long time)

Wait until a specified absolute time is milliseconds.

wakeWait

public void wakeWait()

Interrupt above wait

getSimulationStartTime

public long getSimulationStartTime()

Get the simulation start time. This is the time the simulation actually started.

getStartTime

public long getStartTime()

Get the simulation start time. This is the time the simulation actually started.

getSimulationCurrentTime

public long getSimulationCurrentTime()

Get the simulation current time. This is the current time within the simulation.

getSimulationElapsedTime

public long getSimulationElapsedTime()

Get the simulation elapsed time. This is the elapsed time within the simulation.

getEventTime

public long getEventTime()

Get the time of the current event

elapsedToString

public java.lang.String elapsedToString(long elapsedTime)

Convert an elasped time, in milliseconds, into a string. Converts something like 35432 into 35:43

getManagementConsole

public cc.clayman.console.ManagementConsole getManagementConsole()

Get the ManagementConsole this ComponentController interacts with.

Specified by:

getManagementConsole in interface ComponentController

getMaxRouterId

public int getMaxRouterId()

Accessor function for maxRouterId_

getAPController

public APController getAPController()

Get the APController

getLinkWeight

public int getLinkWeight(int l1,
                int l2)

getAPs

public java.util.ArrayList<java.lang.Integer> getAPs()

List all APs

getAP

public int getAP(int gid)

Get the nominated AP for a router

setAP

public void setAP(int gid,
         int AP)

Set the agg point for router gid to router AP

apSet

public void apSet(int gid,
         int AP)

Set the agg point for router gid to router AP

reportAP

public boolean reportAP(int gid,
               int AP)

Router GID reports a connection to access point AP

checkIsolated

public void checkIsolated(long time)

Check network for isolated nodes and connect them if possible

checkIsolated

public void checkIsolated(long time,
                 int gid)

Check if given node is isolated and connect it if possible

connectNetwork

public void connectNetwork(long time)

Make sure network is connected

preceedEvent

public void preceedEvent(SimEvent e,
                EventScheduler s,
                GlobalController g)

Add or remove events following a simulation event

followEvent

public void followEvent(SimEvent e,
               EventScheduler s,
               GlobalController g,
               java.lang.Object o)

Add or remove events following a simulation event -- object allows global controller to pass extra parameters related to event if necessary

gcFollowEvent

public void gcFollowEvent(SimEvent e,
                 java.lang.Object o)

Follow an event not generated by engine

gcPreceedEvent

public void gcPreceedEvent(SimEvent e)

Preceed an event not generated by engine

connectNetwork

public void connectNetwork(long time,
                  int r1,
                  int r2)

Make sure network is connected from r1 to r2

isLatticeMonitoring

public boolean isLatticeMonitoring()

getOptions

public ControlOptions getOptions()

Accessor function for ControlOptions structure options_

getRouterList

public java.util.ArrayList<java.lang.Integer> getRouterList()

Accessor function for routerList

getRouterId

public int getRouterId(int i)

Return id of ith router

getNoRouters

public int getNoRouters()

Number of routers in simulation

getLocalHostInfo

public LocalHostInfo getLocalHostInfo()

Get the host info for this GlobalController.

setListenPort

public void setListenPort()

Set the port of the GlobalController

setupListenPort

protected int setupListenPort()

Setup the port for this GlobalController

getPort

public int getPort()

Get the port for this GlobalController

getName

public java.lang.String getName()

Get the name of this GlobalController.

Specified by:

getName in interface ComponentController

setStartupFile

public void setStartupFile(java.lang.String file)

Set the startup file