org.onosproject.mfwd.impl

Class McastRouteBase

java.lang.Object

org.onosproject.mfwd.impl.McastRouteBase

Direct Known Subclasses:

McastRouteGroup, McastRouteSource

public class McastRouteBase
extends Object

McastRouteBase base class for McastRouteGroup and McastRouteSource.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dirty
protected Set<McastConnectPoint>	egressPoints
protected org.onlab.packet.IpPrefix	gaddr
protected McastConnectPoint	ingressPoint
protected org.onosproject.net.intent.Key	intentKey If the intentKey is null that means no intent has been installed.
protected boolean	isGroup
protected org.onlab.packet.IpPrefix	saddr

Constructor Summary

Constructors

Constructor and Description
McastRouteBase(org.onlab.packet.IpPrefix gpfx) Set the source and group address value of a (*, G) group.
McastRouteBase(org.onlab.packet.IpPrefix saddr, org.onlab.packet.IpPrefix gaddr) Create a multicast route constructor.
McastRouteBase(String gaddr) Create a multicast group table entry.
McastRouteBase(String saddr, String gaddr) Create a multicast route.

Method Summary

Modifier and Type	Method and Description
McastConnectPoint	addEgressPoint(org.onosproject.net.ConnectPoint cp) Add an egress McastConnectPoint.
McastConnectPoint	addEgressPoint(org.onosproject.net.ConnectPoint cp, McastConnectPoint.JoinSource interest) Add an egress McastConnectPoint.
McastConnectPoint	addEgressPoint(String connectPoint) Add an egress connect point from a string.
McastConnectPoint	addEgressPoint(String cpstr, McastConnectPoint.JoinSource interest) Add an egress McastConnectPoint.
boolean	addIngressPoint(org.onosproject.net.ConnectPoint ingress) Add an ingress point to this route.
boolean	addIngressPoint(String connectPoint) Add or modify the ingress connect point.
McastConnectPoint	findEgressConnectPoint(org.onosproject.net.ConnectPoint cp) Find the Multicast Connect Point that contains the ConnectPoint.
boolean	getDirty() Get the dirty state.
Set<org.onosproject.net.ConnectPoint>	getEgressConnectPoints() Get egress McastConnectPoints points as ConnectPoints for intent system.
Set<McastConnectPoint>	getEgressPoints() Get egress connect points for the route.
org.onlab.packet.IpPrefix	getGaddr() Get the multicast group address.
McastConnectPoint	getIngressPoint() Get the ingress McastConnectPoint.
org.onosproject.net.intent.Key	getIntentKey() Get the intent key represented by this route.
int	getPuntCount() Get the number of times the packet has been punted.
org.onlab.packet.IpPrefix	getSaddr() Get the multicast source address.
void	incrementPuntCount() Increment the punt count.
boolean	isGroup() Is this a multicast group route?
boolean	isIp4() Is this an IPv4 multicast route.
boolean	isIp6() Is this an IPv6 multicast route.
boolean	isSource()
boolean	removeEgressPoint(org.onosproject.net.ConnectPoint cp) Remove an egress from McastConnectPoint.
boolean	removeEgressPoint(String connectPoint) Remove an egress from McastConnectPoint.
boolean	removeInterest(McastConnectPoint mcp, McastConnectPoint.JoinSource interest) Remove specified interest from the given ConnectPoint.
void	setDirty(boolean dirty) Set the dirty state to indicate that something changed.
void	setIntent() Have the McastIntentManager create and set the intent, then save the intent key.
void	setIntent(org.onosproject.net.intent.SinglePointToMultiPointIntent intent) Set the Intent key.
String	toString() Pretty Print this Multicast Route.
void	withdrawIntent() Withdraw the intent and set the key to null.

Methods inherited from class java.lang.Object

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

Field Detail

gaddr

protected final org.onlab.packet.IpPrefix gaddr

saddr

protected final org.onlab.packet.IpPrefix saddr

ingressPoint

protected McastConnectPoint ingressPoint

egressPoints

protected Set<McastConnectPoint> egressPoints

isGroup

protected boolean isGroup

dirty

protected boolean dirty

intentKey

protected org.onosproject.net.intent.Key intentKey

If the intentKey is null that means no intent has been installed.

Constructor Detail

McastRouteBase

public McastRouteBase(String saddr,
                      String gaddr)

Create a multicast route. This is the parent class for both the Group and the source.

Parameters:

saddr - source address

gaddr - multicast group address

McastRouteBase

public McastRouteBase(String gaddr)

Create a multicast group table entry.

Parameters:

gaddr - multicast group address

McastRouteBase

public McastRouteBase(org.onlab.packet.IpPrefix gpfx)

Set the source and group address value of a (*, G) group.

Parameters:

gpfx - the group prefix address

McastRouteBase

public McastRouteBase(org.onlab.packet.IpPrefix saddr,
                      org.onlab.packet.IpPrefix gaddr)

Create a multicast route constructor.

Parameters:

saddr - source address

gaddr - group address

Method Detail

getGaddr

public org.onlab.packet.IpPrefix getGaddr()

Get the multicast group address.

Returns:

the multicast group address

getSaddr

public org.onlab.packet.IpPrefix getSaddr()

Get the multicast source address.

Returns:

the multicast source address

isIp4

public boolean isIp4()

Is this an IPv4 multicast route.

Returns:

true if it is an IPv4 route

isIp6

public boolean isIp6()

Is this an IPv6 multicast route.

Returns:

true if it is an IPv6 route

isGroup

public boolean isGroup()

Is this a multicast group route?

Returns:

true if it is a multicast group route.

isSource

public boolean isSource()

Returns:

true if this is (S, G) false if it (*, G).

getDirty

public boolean getDirty()

Get the dirty state.

Returns:

whether this route is dirty or not.

setDirty

public void setDirty(boolean dirty)

Set the dirty state to indicate that something changed. This may require an update to the flow tables (intents).

Parameters:

dirty - set the dirty bit

addIngressPoint

public boolean addIngressPoint(org.onosproject.net.ConnectPoint ingress)

Add an ingress point to this route.

Parameters:

ingress - incoming connect point

Returns:

whether ingress has been added, only add if ingressPoint is null

addIngressPoint

public boolean addIngressPoint(String connectPoint)

Add or modify the ingress connect point.

Parameters:

connectPoint - string switch device Id

Returns:

whether ingress has been added, only add if ingressPoint is null

getIngressPoint

public McastConnectPoint getIngressPoint()

Get the ingress McastConnectPoint.

Returns:

the ingress McastConnectPoint

addEgressPoint

public McastConnectPoint addEgressPoint(org.onosproject.net.ConnectPoint cp)

Add an egress McastConnectPoint.

Parameters:

cp - egress connect point

Returns:

return the McastConnectPoint

addEgressPoint

public McastConnectPoint addEgressPoint(String connectPoint)

Add an egress connect point from a string.

Parameters:

connectPoint - string representing a connect point

Returns:

the MulticastConnectPoint

addEgressPoint

public McastConnectPoint addEgressPoint(org.onosproject.net.ConnectPoint cp,
                                        McastConnectPoint.JoinSource interest)

Add an egress McastConnectPoint.

Parameters:

cp - the egress connect point

interest - the source of interest for mcast traffic

Returns:

return the McastConnectPoint

removeEgressPoint

public boolean removeEgressPoint(String connectPoint)

Remove an egress from McastConnectPoint.

Parameters:

connectPoint - the egress connect point

Returns:

boolean result of removal

removeEgressPoint

public boolean removeEgressPoint(org.onosproject.net.ConnectPoint cp)

Remove an egress from McastConnectPoint.

Parameters:

cp - the egress connect point

Returns:

boolean result of removal

addEgressPoint

public McastConnectPoint addEgressPoint(String cpstr,
                                        McastConnectPoint.JoinSource interest)

Add an egress McastConnectPoint.

Parameters:

cpstr - deviceId/port of the connect point

interest - the protocol that has shown interest in this route

Returns:

return the McastConnectPoint

getEgressPoints

public Set<McastConnectPoint> getEgressPoints()

Get egress connect points for the route.

Returns:

Set of egress connect points

getEgressConnectPoints

public Set<org.onosproject.net.ConnectPoint> getEgressConnectPoints()

Get egress McastConnectPoints points as ConnectPoints for intent system.

Returns:

Set of egress ConnectPoints

findEgressConnectPoint

public McastConnectPoint findEgressConnectPoint(org.onosproject.net.ConnectPoint cp)

Find the Multicast Connect Point that contains the ConnectPoint.

Parameters:

cp - the regular ConnectPoint to match

Returns:

the McastConnectPoint that contains cp or null if not found.

removeInterest

public boolean removeInterest(McastConnectPoint mcp,
                              McastConnectPoint.JoinSource interest)

Remove specified interest from the given ConnectPoint.

Parameters:

mcp - connect point.

interest - the protocol interested in this multicast stream

Returns:

true if removed, false otherwise

getPuntCount

public int getPuntCount()

Get the number of times the packet has been punted.

Returns:

the punt count

incrementPuntCount

public void incrementPuntCount()

Increment the punt count. TODO: we need to handle wrapping.

setIntent

public void setIntent()

Have the McastIntentManager create and set the intent, then save the intent key. If we already have an intent, we will first withdraw the existing intent and replace it with a new one. This will support the case where the ingress connectPoint or group of egress connectPoints change.

setIntent

public void setIntent(org.onosproject.net.intent.SinglePointToMultiPointIntent intent)

Set the Intent key.

Parameters:

intent - the multicast intent

getIntentKey

public org.onosproject.net.intent.Key getIntentKey()

Get the intent key represented by this route.

Returns:

intentKey

withdrawIntent

public void withdrawIntent()

Withdraw the intent and set the key to null.

toString

public String toString()

Pretty Print this Multicast Route. Works for McastRouteSource and McastRouteGroup.

Overrides:

toString in class Object

Returns:

pretty string of the multicast route