org.onosproject.pim.impl

Class PimNeighbor

java.lang.Object

org.onosproject.pim.impl.PimNeighbor

public class PimNeighbor
extends Object

Represents a PIM neighbor.

Constructor Summary

Constructors

Constructor and Description
PimNeighbor(org.onlab.packet.IpAddress ipAddress, org.onlab.packet.MacAddress macAddress, short holdTime, int pruneDelay, int priority, int genId) Class constructor.

Method Summary

Modifier and Type	Method and Description
static PimNeighbor	createPimNeighbor(org.onlab.packet.IpAddress ipAddress, org.onlab.packet.MacAddress macAddress, Collection<org.onlab.packet.pim.PIMHelloOption> opts) Creates a PIM neighbor based on an IP, MAC, and collection of PIM HELLO options.
boolean	equals(Object other)
int	generationId() Gets our neighbor's generation ID.
int	hashCode()
short	holdtime() Gets our neighbor's hold time.
org.onlab.packet.IpAddress	ipAddress() Gets the IP address of our neighbor.
boolean	isExpired() Returns whether this neighbor is expired or not.
long	lastRefresh() Gets the last time we heard a HELLO from this neighbor.
org.onlab.packet.MacAddress	macAddress() Gets the MAC address of this neighbor.
int	priority() Gets our neighbor's priority.
int	pruneDelay() Gets our neighbor's prune delay.
void	refreshTimestamp() Refreshes this neighbor's last seen timestamp.
String	toString()
long	upTime() Gets the time that we first learnt of this neighbor.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PimNeighbor

public PimNeighbor(org.onlab.packet.IpAddress ipAddress,
                   org.onlab.packet.MacAddress macAddress,
                   short holdTime,
                   int pruneDelay,
                   int priority,
                   int genId)

Class constructor.

Parameters:

ipAddress - neighbor IP address

macAddress - neighbor MAC address

holdTime - hold time

pruneDelay - prune delay

priority - priority

genId - generation ID

Method Detail

ipAddress

public org.onlab.packet.IpAddress ipAddress()

Gets the IP address of our neighbor.

Returns:

the IP address of our neighbor

macAddress

public org.onlab.packet.MacAddress macAddress()

Gets the MAC address of this neighbor.

Returns:

the mac address

holdtime

public short holdtime()

Gets our neighbor's hold time.

Returns:

the hold time

pruneDelay

public int pruneDelay()

Gets our neighbor's prune delay.

Returns:

our neighbor's prune delay

priority

public int priority()

Gets our neighbor's priority.

Returns:

our neighbor's priority

generationId

public int generationId()

Gets our neighbor's generation ID.

Returns:

our neighbor's generation ID

lastRefresh

public long lastRefresh()

Gets the last time we heard a HELLO from this neighbor.

Returns:

last refresh time

upTime

public long upTime()

Gets the time that we first learnt of this neighbor.

Returns:

up time

refreshTimestamp

public void refreshTimestamp()

Refreshes this neighbor's last seen timestamp.

isExpired

public boolean isExpired()

Returns whether this neighbor is expired or not.

Returns:

true if the neighbor is expired, otherwise false

createPimNeighbor

public static PimNeighbor createPimNeighbor(org.onlab.packet.IpAddress ipAddress,
                                            org.onlab.packet.MacAddress macAddress,
                                            Collection<org.onlab.packet.pim.PIMHelloOption> opts)

Creates a PIM neighbor based on an IP, MAC, and collection of PIM HELLO options.

Parameters:

ipAddress - neighbor IP address

macAddress - neighbor MAC address

opts - options from the PIM HELLO packet

Returns:

new PIM neighbor

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object