org.onosproject.pim.impl

Class PIMInterface

java.lang.Object

org.onosproject.pim.impl.PIMInterface

public final class PIMInterface
extends Object

PIM Interface represents an ONOS Interface with IP and MAC addresses for a given ConnectPoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PIMInterface.Builder Builder for a PIM interface.

Method Summary

Modifier and Type	Method and Description
void	addRoute(org.onosproject.net.mcast.McastRoute route, org.onlab.packet.IpAddress nextHop, org.onlab.packet.MacAddress nextHopMac)
static PIMInterface.Builder	builder() Returns a builder for a PIM interface.
void	checkNeighborTimeouts() Checks whether any of our neighbors have expired, and cleans up their state if they have.
int	getGenerationId() Get our generation ID.
short	getHoldtime() Get the holdtime.
org.onosproject.incubator.net.intf.Interface	getInterface() Return the ONOS Interface.
org.onlab.packet.IpAddress	getIpAddress() Return a single "best" IP address.
List<org.onosproject.net.host.InterfaceIpAddress>	getIpAddresses() Get the set of IP Addresses associated with this interface.
Collection<PIMNeighbor>	getNeighbors() Gets the neighbors seen on this interface.
int	getPriority() Get our hello priority.
int	getPruneDelay() Get the prune delay.
Collection<org.onosproject.net.mcast.McastRoute>	getRoutes()
void	processHello(org.onlab.packet.Ethernet ethPkt) Process an incoming PIM Hello message.
void	processJoinPrune(org.onlab.packet.Ethernet ethPkt) Process an incoming PIM JoinPrune message.
void	removeRoute(org.onosproject.net.mcast.McastRoute route)
void	sendHello() Multicast a hello message out our interface.
void	sendJoins()
PIMInterface	setInterface(org.onosproject.incubator.net.intf.Interface intf) Set the ONOS Interface, it will override a previous value.

Methods inherited from class java.lang.Object

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

Method Detail

getInterface

public org.onosproject.incubator.net.intf.Interface getInterface()

Return the ONOS Interface.

Returns:

ONOS Interface.

setInterface

public PIMInterface setInterface(org.onosproject.incubator.net.intf.Interface intf)

Set the ONOS Interface, it will override a previous value.

Parameters:

intf - ONOS Interface

Returns:

PIM interface instance

getIpAddresses

public List<org.onosproject.net.host.InterfaceIpAddress> getIpAddresses()

Get the set of IP Addresses associated with this interface.

Returns:

a set of Ip Addresses on this interface

getIpAddress

public org.onlab.packet.IpAddress getIpAddress()

Return a single "best" IP address.

Returns:

the choosen IP address or null if none

getHoldtime

public short getHoldtime()

Get the holdtime.

Returns:

the holdtime

getPruneDelay

public int getPruneDelay()

Get the prune delay.

Returns:

The prune delay

getPriority

public int getPriority()

Get our hello priority.

Returns:

our priority

getGenerationId

public int getGenerationId()

Get our generation ID.

Returns:

our generation ID

getNeighbors

public Collection<PIMNeighbor> getNeighbors()

Gets the neighbors seen on this interface.

Returns:

PIM neighbors

getRoutes

public Collection<org.onosproject.net.mcast.McastRoute> getRoutes()

checkNeighborTimeouts

public void checkNeighborTimeouts()

Checks whether any of our neighbors have expired, and cleans up their state if they have.

sendHello

public void sendHello()

Multicast a hello message out our interface. This hello message is sent periodically during the normal PIM Neighbor refresh time, as well as a result of a newly created interface.

processHello

public void processHello(org.onlab.packet.Ethernet ethPkt)

Process an incoming PIM Hello message. There are a few things going on in this method:

• We may have to create a new neighbor if one does not already exist
• We may need to re-elect a new DR if new information is received
• We may need to send an existing neighbor all joins if the genid changed
• We will refresh the neighbor's timestamp

Parameters:

ethPkt - the Ethernet packet header

processJoinPrune

public void processJoinPrune(org.onlab.packet.Ethernet ethPkt)

Process an incoming PIM JoinPrune message.

Parameters:

ethPkt - the Ethernet packet header.

addRoute

public void addRoute(org.onosproject.net.mcast.McastRoute route,
                     org.onlab.packet.IpAddress nextHop,
                     org.onlab.packet.MacAddress nextHopMac)

removeRoute

public void removeRoute(org.onosproject.net.mcast.McastRoute route)

sendJoins

public void sendJoins()

builder

public static PIMInterface.Builder builder()

Returns a builder for a PIM interface.

Returns:

PIM interface builder