core

Class DTNHost

java.lang.Object

core.DTNHost

All Implemented Interfaces:

java.lang.Comparable<DTNHost>

public class DTNHost
extends java.lang.Object
implements java.lang.Comparable<DTNHost>

A DTN capable host.

Constructor Summary

Constructors

Constructor and Description
DTNHost(java.util.List<MessageListener> msgLs, java.util.List<MovementListener> movLs, java.lang.String groupId, java.util.List<NetworkInterface> interf, ModuleCommunicationBus comBus, MovementModel mmProto, MessageRouter mRouterProto) Creates a new DTNHost.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAccidentAt(MapNode node) Add node to the set of known accidents
int	compareTo(DTNHost h) Compares two DTNHosts by their addresses.
void	connect(DTNHost h) for tests only --- do not use!!!
void	connectionDown(Connection con)
void	connectionUp(Connection con) Informs the router of this host about state change in a connection object.
void	createNewMessage(Message m) Creates a new message to this host's router
void	deleteMessage(java.lang.String id, boolean drop) Deletes a message from this host
boolean	equals(DTNHost otherHost) Checks if a host is the same as this host by comparing the object reference
void	forceConnection(DTNHost anotherHost, java.lang.String interfaceId, boolean up) Force a connection event
int	getAddress() Returns the network-layer address of this host.
double	getBufferOccupancy() Returns the buffer occupancy percentage.
ModuleCommunicationBus	getComBus() Returns this hosts's ModuleCommunicationBus
java.util.List<Connection>	getConnections() Returns a copy of the list of connections this host has with other hosts
int	getDangerMode() Return the danger mode
NetworkInterface	getInterface(int interfaceNo) Find the network interface based on the index
protected NetworkInterface	getInterface(java.lang.String interfacetype) Find the network interface based on the interfacetype
java.util.List<NetworkInterface>	getInterfaces() Returns the interface objects of the node
java.util.Set<MapNode>	getKnownAccidents() Getter for known accidents set
java.util.Map<DTNHost,util.Tuple<Coord,java.lang.Integer>>	getKnownLocations() Getter for the known locations map
Coord	getLocation() Returns the current location of this host.
java.util.Collection<Message>	getMessageCollection() Returns the messages in a collection.
java.util.List<MapNode>	getNodePath() Getter for nodePath nodePath is a list of the entire path between the node and his final destination (computed by Dijkstra's algorithm)
int	getNrofMessages() Returns the number of messages this node is carrying.
Path	getPath() Returns the Path this node is currently traveling or null if no path is in use at the moment.
MessageRouter	getRouter() Returns the router of this host
RoutingInfo	getRoutingInfo() Returns routing info of this host's router.
int	getStamp() Getter for stamp
boolean	isAwareOfAccidentAt(MapNode from) True if the host if aware of the accident at the node
boolean	isMovementActive() Returns true if this node is actively moving (false if not)
boolean	isRadioActive() Returns true if this node's radio is active (false if not)
boolean	isRecalculatingRoute() Getter for recalculatingRoute boolean
boolean	isStucked() Return the stucked boolean
boolean	isWarned() Return the warned boolean
void	messageAborted(java.lang.String id, DTNHost from, int bytesRemaining) Informs the host that a message transfer was aborted.
void	messageTransferred(java.lang.String id, DTNHost from) Informs the host that a message was successfully transferred.
void	move(double timeIncrement) Moves the node towards the next waypoint or waits if it is not time to move yet
int	receiveMessage(Message m, DTNHost from) Start receiving a message from another host
boolean	requestDeliverableMessages(Connection con) Requests for deliverable message from this host to be sent trough a connection.
static void	reset() Reset the host and its interfaces
void	sendMessage(java.lang.String id, DTNHost to) Sends a message from this host to another host
void	setDangerMode(int dangerMode) Set the danger mode
void	setLocation(Coord location) Sets the Node's location overriding any location set by movement model
void	setName(java.lang.String name) Sets the Node's name overriding the default name (groupId + netAddress)
void	setNodePath(java.util.List<MapNode> nodePath) Setter for nodePath
void	setRecalculatingRoute(boolean recalculatingRoute) Setter for recalculatingRoute boolean
void	setStamp(int stamp) Setter for stamp
void	setStucked(boolean stucked) Set stucked boolean
void	setWarned(boolean warned) Set warned boolean
java.lang.String	toString() Returns a string presentation of the host.
void	update(boolean simulateConnections) Updates node's network layer and router.
void	updateKnownLocations(DTNHost host, Coord c, java.lang.Integer stamp) Update known location based on freshness value
void	updateSelfKnownLocation() Update self known location Should be called before sending message

Methods inherited from class java.lang.Object

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

Constructor Detail

DTNHost

public DTNHost(java.util.List<MessageListener> msgLs,
       java.util.List<MovementListener> movLs,
       java.lang.String groupId,
       java.util.List<NetworkInterface> interf,
       ModuleCommunicationBus comBus,
       MovementModel mmProto,
       MessageRouter mRouterProto)

Creates a new DTNHost.

Parameters:

msgLs - Message listeners

movLs - Movement listeners

groupId - GroupID of this host

interf - List of NetworkInterfaces for the class

comBus - Module communication bus object

mmProto - Prototype of the movement model of this host

mRouterProto - Prototype of the message router of this host

Method Detail

reset

public static void reset()

Reset the host and its interfaces

isMovementActive

public boolean isMovementActive()

Returns true if this node is actively moving (false if not)

Returns:

true if this node is actively moving (false if not)

isRadioActive

public boolean isRadioActive()

Returns true if this node's radio is active (false if not)

Returns:

true if this node's radio is active (false if not)

getRouter

public MessageRouter getRouter()

Returns the router of this host

Returns:

the router of this host

getAddress

public int getAddress()

Returns the network-layer address of this host.

getComBus

public ModuleCommunicationBus getComBus()

Returns this hosts's ModuleCommunicationBus

Returns:

this hosts's ModuleCommunicationBus

connectionUp

public void connectionUp(Connection con)

Informs the router of this host about state change in a connection object.

Parameters:

con - The connection object whose state changed

connectionDown

public void connectionDown(Connection con)

getConnections

public java.util.List<Connection> getConnections()

Returns a copy of the list of connections this host has with other hosts

Returns:

a copy of the list of connections this host has with other hosts

getLocation

public Coord getLocation()

Returns the current location of this host.

Returns:

The location

getPath

public Path getPath()

Returns the Path this node is currently traveling or null if no path is in use at the moment.

Returns:

The path this node is traveling

setLocation

public void setLocation(Coord location)

Sets the Node's location overriding any location set by movement model

Parameters:

location - The location to set

setName

public void setName(java.lang.String name)

Sets the Node's name overriding the default name (groupId + netAddress)

Parameters:

name - The name to set

getMessageCollection

public java.util.Collection<Message> getMessageCollection()

Returns the messages in a collection.

Returns:

Messages in a collection

getNrofMessages

public int getNrofMessages()

Returns the number of messages this node is carrying.

Returns:

How many messages the node is carrying currently.

getBufferOccupancy

public double getBufferOccupancy()

Returns the buffer occupancy percentage. Occupancy is 0 for empty buffer but can be over 100 if a created message is bigger than buffer space that could be freed.

Returns:

Buffer occupancy percentage

getRoutingInfo

public RoutingInfo getRoutingInfo()

Returns routing info of this host's router.

Returns:

The routing info.

getInterfaces

public java.util.List<NetworkInterface> getInterfaces()

Returns the interface objects of the node

getInterface

public NetworkInterface getInterface(int interfaceNo)

Find the network interface based on the index

getInterface

protected NetworkInterface getInterface(java.lang.String interfacetype)

Find the network interface based on the interfacetype

forceConnection

public void forceConnection(DTNHost anotherHost,
                   java.lang.String interfaceId,
                   boolean up)

Force a connection event

connect

public void connect(DTNHost h)

for tests only --- do not use!!!

update

public void update(boolean simulateConnections)

Updates node's network layer and router.

Parameters:

simulateConnections - Should network layer be updated too

move

public void move(double timeIncrement)

Moves the node towards the next waypoint or waits if it is not time to move yet

Parameters:

timeIncrement - How long time the node moves

sendMessage

public void sendMessage(java.lang.String id,
               DTNHost to)

Sends a message from this host to another host

Parameters:

id - Identifier of the message

to - Host the message should be sent to

receiveMessage

public int receiveMessage(Message m,
                 DTNHost from)

Start receiving a message from another host

Parameters:

m - The message

from - Who the message is from

Returns:

The value returned by MessageRouter.receiveMessage(Message, DTNHost)

messageTransferred

public void messageTransferred(java.lang.String id,
                      DTNHost from)

Informs the host that a message was successfully transferred.

Parameters:

id - Identifier of the message

from - From who the message was from

requestDeliverableMessages

public boolean requestDeliverableMessages(Connection con)

Requests for deliverable message from this host to be sent trough a connection.

Parameters:

con - The connection to send the messages trough

Returns:

True if this host started a transfer, false if not

messageAborted

public void messageAborted(java.lang.String id,
                  DTNHost from,
                  int bytesRemaining)

Informs the host that a message transfer was aborted.

Parameters:

id - Identifier of the message

from - From who the message was from

bytesRemaining - Nrof bytes that were left before the transfer would have been ready; or -1 if the number of bytes is not known

createNewMessage

public void createNewMessage(Message m)

Creates a new message to this host's router

Parameters:

m - The message to create

deleteMessage

public void deleteMessage(java.lang.String id,
                 boolean drop)

Deletes a message from this host

Parameters:

id - Identifier of the message

drop - True if the message is deleted because of "dropping" (e.g. buffer is full) or false if it was deleted for some other reason (e.g. the message got delivered to final destination). This effects the way the removing is reported to the message listeners.

toString

public java.lang.String toString()

Returns a string presentation of the host.

Overrides:

toString in class java.lang.Object

Returns:

Host's name

equals

public boolean equals(DTNHost otherHost)

Checks if a host is the same as this host by comparing the object reference

Parameters:

otherHost - The other host

Returns:

True if the hosts objects are the same object

compareTo

public int compareTo(DTNHost h)

Compares two DTNHosts by their addresses.

Specified by:

compareTo in interface java.lang.Comparable<DTNHost>

See Also:

Comparable.compareTo(Object)

getDangerMode

public int getDangerMode()

Return the danger mode

Returns:

the danger mode

setDangerMode

public void setDangerMode(int dangerMode)

Set the danger mode

Parameters:

dangerMode -

isWarned

public boolean isWarned()

Return the warned boolean

Returns:

the warned boolean

setWarned

public void setWarned(boolean warned)

Set warned boolean

Parameters:

warned - boolean

isStucked

public boolean isStucked()

Return the stucked boolean

Returns:

the stucked boolean

setStucked

public void setStucked(boolean stucked)

Set stucked boolean

Parameters:

stucked - boolean

isAwareOfAccidentAt

public boolean isAwareOfAccidentAt(MapNode from)

True if the host if aware of the accident at the node

Parameters:

from - node

Returns:

true if the host if aware of the accident at the node

addAccidentAt

public void addAccidentAt(MapNode node)

Add node to the set of known accidents

Parameters:

node - Accident node

getKnownAccidents

public java.util.Set<MapNode> getKnownAccidents()

Getter for known accidents set

Returns:

know accidents set

getKnownLocations

public java.util.Map<DTNHost,util.Tuple<Coord,java.lang.Integer>> getKnownLocations()

Getter for the known locations map

Returns:

the known locations map

updateKnownLocations

public void updateKnownLocations(DTNHost host,
                        Coord c,
                        java.lang.Integer stamp)

Update known location based on freshness value

Parameters:

host - host

c - coord of the host

h - freshness value

updateSelfKnownLocation

public void updateSelfKnownLocation()

Update self known location Should be called before sending message

getStamp

public int getStamp()

Getter for stamp

Returns:

stamp

setStamp

public void setStamp(int stamp)

Setter for stamp

Parameters:

stamp -

isRecalculatingRoute

public boolean isRecalculatingRoute()

Getter for recalculatingRoute boolean

Returns:

recalculatingRoute boolean

setRecalculatingRoute

public void setRecalculatingRoute(boolean recalculatingRoute)

Setter for recalculatingRoute boolean

Parameters:

recalculatingRoute - boolean

getNodePath

public java.util.List<MapNode> getNodePath()

Getter for nodePath nodePath is a list of the entire path between the node and his final destination (computed by Dijkstra's algorithm)

Returns:

nodePath

setNodePath

public void setNodePath(java.util.List<MapNode> nodePath)

Setter for nodePath

Parameters:

nodePath -