RouteDiscoveryNtf (UnetStack 3.4.0 API)

org.arl.unet.net.RouteDiscoveryNtf

Notification sent to inform other agents of newly discovered route.
See Also:
RouteDiscoveryReq

Field Summary

Fields
Modifiers	Name	Description
`protected int`	`hops`
`protected AgentID`	`link`
`protected int`	`nextHop`
`protected boolean`	`reliability`
`protected List<Integer>`	`route`
`protected int`	`to`

Properties Summary

Properties
Type	Name and description
`int`	`hops`
`AgentID`	`link`
`int`	`nextHop`
`List<Integer>`	`route`
`int`	`to`

Constructor Summary

Constructors
Constructor and description
`RouteDiscoveryNtf ()` Create a new route dicovery notification.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`getHops()` Gets the hop count to destination.
	`AgentID`	`getLink()` Gets the next hop link to use.
	`int`	`getNextHop()` Gets the next hop node address.
	`boolean`	`getReliability()` Gets the reliability of the next hop link.
	`List<Integer>`	`getRoute()` Gets the detailed route to destination.
	`int`	`getTo()` Gets the destination node address.
	`void`	`setHops(int hops)` Sets the hop count to destination.
	`void`	`setLink(AgentID link)` Sets the next hop link to use.
	`void`	`setNextHop(int nextHop)` Sets the next hop node address.
	`void`	`setReliability(boolean reliability)` Sets the reliability of the next hop link.
	`void`	`setRoute(List<Integer> route)` Sets the detailed route to destination.
	`void`	`setTo(int to)` Sets the destination node address.
	`String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Message`	`setPerformative, toString, getSender, setMessageID, getSentAt, setRecipient, getInReplyTo, setSentAt, setSender, getPerformative, getRecipient, getMessageID, setInReplyTo, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected int hops
  - protected AgentID link
  - protected int nextHop
  - protected boolean reliability
  - protected List<Integer> route
  - protected int to
- Property Detail
  - int hops
  - AgentID link
  - int nextHop
  - List<Integer> route
  - int to
- Constructor Detail
  - public RouteDiscoveryNtf()
    
    Create a new route dicovery notification.
- Method Detail
  - public int getHops()
    
    Gets the hop count to destination.
    Returns:
    hop count
  - public AgentID getLink()
    
    Gets the next hop link to use.
    Returns:
    agent id of next hop link
  - public int getNextHop()
    
    Gets the next hop node address.
    Returns:
    next hop node address
  - public boolean getReliability()
    
    Gets the reliability of the next hop link.
    Returns:
    true if reliable, false otherwise
  - public List<Integer> getRoute()
    
    Gets the detailed route to destination.
    Returns:
    list of nodes forming a route to destination, if available, null otherwise
  - public int getTo()
    
    Gets the destination node address.
    Returns:
    destination node address
  - public void setHops(int hops)
    
    Sets the hop count to destination.
    Parameters:
    hops - hop count
  - public void setLink(AgentID link)
    
    Sets the next hop link to use.
    Parameters:
    link - agent id of next hop link
  - public void setNextHop(int nextHop)
    
    Sets the next hop node address.
    Parameters:
    nextHop - next hop node address
  - public void setReliability(boolean reliability)
    
    Sets the reliability of the next hop link.
    Parameters:
    reliability - true if reliable, false otherwise
  - public void setRoute(List<Integer> route)
    
    Sets the detailed route to destination.
    Parameters:
    route - list of nodes forming a route to destination
  - public void setTo(int to)
    
    Sets the destination node address.
    Parameters:
    to - destination node address
  - @Override public String toString()

Summary:
Field
Property
Constructor
Method

[Java] Class RouteDiscoveryNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected int hops

protected AgentID link

protected int nextHop

protected boolean reliability

protected List<Integer> route

protected int to

Property Detail

int hops

AgentID link

int nextHop

List<Integer> route

int to

Constructor Detail

public RouteDiscoveryNtf()

Method Detail

public int getHops()

public AgentID getLink()

public int getNextHop()

public boolean getReliability()

public List<Integer> getRoute()

public int getTo()

public void setHops(int hops)

public void setLink(AgentID link)

public void setNextHop(int nextHop)

public void setReliability(boolean reliability)

public void setRoute(List<Integer> route)

public void setTo(int to)

@Override public String toString()