org.onosproject.net.mcast

Class McastRouteInfo

java.lang.Object

org.onosproject.net.mcast.McastRouteInfo

public final class McastRouteInfo
extends java.lang.Object

Multicast information as stored in the store.

Method Summary

Modifier and Type	Method and Description
boolean	isComplete()
static McastRouteInfo	mcastRouteInfo(McastRoute route)
static McastRouteInfo	mcastRouteInfo(McastRoute route, ConnectPoint sink, ConnectPoint source)
static McastRouteInfo	mcastRouteInfo(McastRoute route, java.util.Set<ConnectPoint> sinks, ConnectPoint source)
McastRoute	route() The route associated with this multicast information.
java.util.Optional<ConnectPoint>	sink() The sink which has been removed or added.
java.util.Set<ConnectPoint>	sinks() Returns the set of sinks associated with this route.
java.util.Optional<ConnectPoint>	source() The source which has been removed or added.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

mcastRouteInfo

public static McastRouteInfo mcastRouteInfo(McastRoute route)

mcastRouteInfo

public static McastRouteInfo mcastRouteInfo(McastRoute route,
                                            ConnectPoint sink,
                                            ConnectPoint source)

mcastRouteInfo

public static McastRouteInfo mcastRouteInfo(McastRoute route,
                                            java.util.Set<ConnectPoint> sinks,
                                            ConnectPoint source)

isComplete

public boolean isComplete()

route

public McastRoute route()

The route associated with this multicast information.

Returns:

a mulicast route

source

public java.util.Optional<ConnectPoint> source()

The source which has been removed or added.

Returns:

an optional connect point

sink

public java.util.Optional<ConnectPoint> sink()

The sink which has been removed or added. The field may not be set if the sink has not been detected yet or has been removed.

Returns:

an optional connect point

sinks

public java.util.Set<ConnectPoint> sinks()

Returns the set of sinks associated with this route. Only valid with SOURCE_ADDED events.

Returns:

a set of connect points

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object