org.onosproject.mfwd.impl

Class McastRouteTable

java.lang.Object

org.onosproject.mfwd.impl.McastRouteTable

@Service(value=McastRouteTable.class)
public final class McastRouteTable
extends Object

The Mcast Route Table holds all multicast state for the controller. State for IPv4 and IPv6 are maintained. The tables are sets of McastRouteGroup structures that represent (*, G) state with a series of egress ConnectPoints. Each (*, G) may also have a set of (S, G) that may have there own set of ingress and egress ConnectPoints. TODO: perhaps should probably create two separate singleton for IPv4 and IPv6 respectively.

Method Summary

Modifier and Type	Method and Description
McastRouteBase	addRoute(org.onlab.packet.IpPrefix spfx, org.onlab.packet.IpPrefix gpfx) Add a multicast route to the MRIB.
McastRouteBase	addRoute(String saddr, String gaddr) Add a multicast route to the MRIB.
org.onosproject.mfwd.impl.McastRoute	findBestMatch(org.onlab.packet.IpPrefix saddr, org.onlab.packet.IpPrefix gaddr) This will first look up a Group entry.
McastRouteGroup	findMcastGroup(org.onlab.packet.IpPrefix group) Find the specific multicast group entry.
McastRouteSource	findMcastSource(org.onlab.packet.IpPrefix saddr, org.onlab.packet.IpPrefix gaddr) Find the multicast (S, G) entry if it exists.
static McastRouteTable	getInstance() Get the single instance of this multicast group address.
Map<org.onlab.packet.IpPrefix,McastRouteGroup>	getMrib4() Get the IPv4 MRIB.
Map<org.onlab.packet.IpPrefix,McastRouteGroup>	getMrib6() Get the IPv6 MRIB.
String	printMcastRouteTable() Print out the multicast route table in it's entirety.
boolean	removeEgress(String saddr, String gaddr, String egress) Delete a specific egress from the MRIB.
void	removeRoute(org.onlab.packet.IpPrefix spfx, org.onlab.packet.IpPrefix gpfx) Remove a multicast route.
void	removeRoute(String saddr, String gaddr) Delete a multicast route from the MRIB.
String	toString() Print out a summary of groups in the MRIB.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static McastRouteTable getInstance()

Get the single instance of this multicast group address.

Returns:

the multicast route table

getMrib4

public Map<org.onlab.packet.IpPrefix,McastRouteGroup> getMrib4()

Get the IPv4 MRIB.

Returns:

the IPv4 MRIB

getMrib6

public Map<org.onlab.packet.IpPrefix,McastRouteGroup> getMrib6()

Get the IPv6 MRIB.

Returns:

Return the set of prefix keyed McastGroups

addRoute

public McastRouteBase addRoute(String saddr,
                               String gaddr)

Add a multicast route to the MRIB. This function will.

Parameters:

saddr - source address * or x.x.x.x or x.x.x.x/y

gaddr - group address x.x.x.x or x.x.x.x/y

Returns:

the multicast route

addRoute

public McastRouteBase addRoute(org.onlab.packet.IpPrefix spfx,
                               org.onlab.packet.IpPrefix gpfx)

Add a multicast route to the MRIB. This function will store either (S, G) or (*, G) in the mrib if an entry does not already exist. If an entry does exist it is returned to the caller. Every (S, G) is stored as part of it's parent group entry which also represents (*, G) routes. In the case of a (S, G) we will also create the (*, G) entry if needed then save the (S, G) to the (*, G).

Parameters:

spfx - the source prefix

gpfx - the group prefix

Returns:

the resulting McastRouteSource or McastRouteGroup accordingly.

removeEgress

public boolean removeEgress(String saddr,
                            String gaddr,
                            String egress)

Delete a specific egress from the MRIB.

Parameters:

saddr - source address * or x.x.x.x or x.x.x.x/y

gaddr - group address x.x.x.x or x.x.x.x/y

egress - group address x.x.x.x or x.x.x.x/y

Returns:

boolean if egress was deleted

removeRoute

public void removeRoute(String saddr,
                        String gaddr)

Delete a multicast route from the MRIB.

Parameters:

saddr - source address * or x.x.x.x or x.x.x.x/y

gaddr - group address x.x.x.x or x.x.x.x/y

removeRoute

public void removeRoute(org.onlab.packet.IpPrefix spfx,
                        org.onlab.packet.IpPrefix gpfx)

Remove a multicast route.

Parameters:

spfx - the source prefix

gpfx - the group prefix

findMcastGroup

public McastRouteGroup findMcastGroup(org.onlab.packet.IpPrefix group)

Find the specific multicast group entry.

Parameters:

group - the group address

Returns:

McastRouteGroup the multicast (*, G) group route

findMcastSource

public McastRouteSource findMcastSource(org.onlab.packet.IpPrefix saddr,
                                        org.onlab.packet.IpPrefix gaddr)

Find the multicast (S, G) entry if it exists.

Parameters:

saddr - the source address

gaddr - the group address

Returns:

The multicast source route entry if it exists, null if it does not.

findBestMatch

public org.onosproject.mfwd.impl.McastRoute findBestMatch(org.onlab.packet.IpPrefix saddr,
                                                          org.onlab.packet.IpPrefix gaddr)

This will first look up a Group entry. If no group entry was found null will be returned. If the group entry has been found we will then look up the (s, g) entry. If the (s, g) entry has been found, that will be returned. If no (s, g) was found the (*, g) group entry will be returned.

Parameters:

saddr - the source address

gaddr - the group address

Returns:

return the best matching McastRouteSource or McastRouteGroup

printMcastRouteTable

public String printMcastRouteTable()

Print out the multicast route table in it's entirety. TODO: Eventually we will have to implement paging and how to handle large tables.

Returns:

String

toString

public String toString()

Print out a summary of groups in the MRIB.

Overrides:

toString in class Object

Returns:

String