org.onosproject.net.mcast

Interface McastStore

All Superinterfaces:

Store<McastEvent,McastStoreDelegate>

public interface McastStore
extends Store<McastEvent,McastStoreDelegate>

Entity responsible for storing multicast state information.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	McastStore.Type

Method Summary

Modifier and Type	Method and Description
Set<McastRoute>	getRoutes() Gets the set of all known multicast routes.
Set<ConnectPoint>	sinksFor(McastRoute route) Obtains the sinks for a multicast route.
ConnectPoint	sourceFor(McastRoute route) Obtains the source for a multicast route.
void	storeRoute(McastRoute route, McastStore.Type operation) Updates the store with the route information.
void	storeSink(McastRoute route, ConnectPoint sink, McastStore.Type operation) Updates the store with sink information for a given route.
void	storeSource(McastRoute route, ConnectPoint source) Updates the store with source information for the given route.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

storeRoute

void storeRoute(McastRoute route,
                McastStore.Type operation)

Updates the store with the route information.

Parameters:

route - a multicast route

operation - an operation

storeSource

void storeSource(McastRoute route,
                 ConnectPoint source)

Updates the store with source information for the given route. Only one source is permitted. Submitting another source will replace the previous value.

Parameters:

route - a multicast route

source - a source

storeSink

void storeSink(McastRoute route,
               ConnectPoint sink,
               McastStore.Type operation)

Updates the store with sink information for a given route. There may be multiple sinks.

Parameters:

route - a multicast route

sink - a sink

operation - an operation

sourceFor

ConnectPoint sourceFor(McastRoute route)

Obtains the source for a multicast route.

Parameters:

route - a multicast route

Returns:

a connect point

sinksFor

Set<ConnectPoint> sinksFor(McastRoute route)

Obtains the sinks for a multicast route.

Parameters:

route - a multicast route

Returns:

a set of sinks

getRoutes

Set<McastRoute> getRoutes()

Gets the set of all known multicast routes.

Returns:

set of multicast routes