com.sun.spot.peripheral.radio.routing.interfaces
Interface IRoutingManager

All Superinterfaces:

IResource, IService

All Known Implementing Classes:

AODVManager, LQRPManager, SingleHopManager

public interface IRoutingManager
extends IService

This interface defines a routing manager

Version:

0.1

Author:

Allen Ajit George

Field Summary

Fields inherited from interface com.sun.spot.service.IService

PAUSED, PAUSING, READY, RESUMING, RUNNING, STARTING, STOPPED, STOPPING

Method Summary

void	addEventListener(IMHEventListener listener) Registers an event listener that is notified when this node initiates/receives supported route events
void	deregisterEventListener(IMHEventListener listener) Deprecated. use removeEventListener()
boolean	findRoute(long address, RouteEventClient eventClient, Object uniqueKey) This method triggers a new route request.
int	getMaximumHops() Return the maximum number of hops a packet may take in this mesh network
RouteInfo	getRouteInfo(long address) this method can be called to obtain a route info for an address
RouteTable	getRoutingTable() returns a copy of the routing table
void	initialize(long ourAddress, ILowPan lowPanLayer) for the initialization the routing manager must know a low pan instance to interoperate with
boolean	invalidateRoute(long originator, long destination) invalidate a route that is reported to be broken
void	registerEventListener(IMHEventListener listener) Deprecated. use addEventListener()
void	removeEventListener(IMHEventListener listener) Remove the specified event listener that was registered for route events

Methods inherited from interface com.sun.spot.service.IService

getEnabled, getServiceName, getStatus, isRunning, pause, resume, setEnabled, setServiceName, start, stop

Methods inherited from interface com.sun.spot.resources.IResource

addTag, getTags, getTagValue, hasTag, removeTag

Method Detail

initialize

void initialize(long ourAddress,
                ILowPan lowPanLayer)

for the initialization the routing manager must know a low pan instance to interoperate with

Parameters:

ourAddress -

lowPanLayer -

getRouteInfo

RouteInfo getRouteInfo(long address)

this method can be called to obtain a route info for an address

Parameters:

address -

findRoute

boolean findRoute(long address,
                  RouteEventClient eventClient,
                  Object uniqueKey)
                  throws NoRouteException

This method triggers a new route request. Note: the radio must be on or no route will be found.

Throws:

NoRouteException

getRoutingTable

RouteTable getRoutingTable()

returns a copy of the routing table

invalidateRoute

boolean invalidateRoute(long originator,
                        long destination)

invalidate a route that is reported to be broken

registerEventListener

void registerEventListener(IMHEventListener listener)

Deprecated. use addEventListener()

Registers an application etc. that is notified when this node initiates/receives supported route events

Parameters:

listener - object that is notified when route events occur

deregisterEventListener

void deregisterEventListener(IMHEventListener listener)

Deprecated. use removeEventListener()

Deregisters an application etc. that was registered for route events

Parameters:

listener - object that is notified when route events occur

addEventListener

void addEventListener(IMHEventListener listener)

Registers an event listener that is notified when this node initiates/receives supported route events

Parameters:

listener - object that is notified when route events occur

removeEventListener

void removeEventListener(IMHEventListener listener)

Remove the specified event listener that was registered for route events

Parameters:

listener - object that is notified when route events occur

getMaximumHops

int getMaximumHops()

Return the maximum number of hops a packet may take in this mesh network

Returns:

the maximum number of hops across this network