com.hp.sdn.macgrp

Interface MacGroupService

public interface MacGroupService

This interface defines how to manage Mac groups on the datapaths. The Mac group is created or deleted on the datapaths. Mac addresses can be added into or deleted from Mac groups. From the MacGroupId, one can know what Mac addresses are configured under it.

Author:

Chao Shi

Method Summary

Methods

Modifier and Type	Method and Description
void	addMacs(MacGroupId mid, Set<MacAddress> macs) Add Mac addresses into the existing Mac group
Map<MacGroupId,MacGroup>	getMacGroups(DataPathId dpid, MacGroup.Type type) List Mac groups from the dataPath by type
Set<MacAddress>	getMacs(MacGroupId mid) List all member Mac addresses in the given Mac group
void	removeAllMacs(MacGroupId mid) Delete a Mac group from the datapath and remove all its member Mac addresses.
void	removeMacs(MacGroupId mid, Set<MacAddress> macs) Remove Mac addresses from the existing Mac group

Method Detail

addMacs

void addMacs(MacGroupId mid,
           Set<MacAddress> macs)

Add Mac addresses into the existing Mac group

Parameters:

mid - Mac group Id, tuple of (dataPath ID, SRC/DST, group ID)

macs - Set of Mac Addresses to add

removeMacs

void removeMacs(MacGroupId mid,
              Set<MacAddress> macs)

Remove Mac addresses from the existing Mac group

Parameters:

mid - Mac group Id, tuple of (dataPath ID, SRC/DST, group ID)

macs - Set of Mac Addresses to remove

removeAllMacs

void removeAllMacs(MacGroupId mid)

Delete a Mac group from the datapath and remove all its member Mac addresses.

Parameters:

mid - Mac group Id, tuple of (dataPath ID, SRC/DST, group ID)

getMacs

Set<MacAddress> getMacs(MacGroupId mid)

List all member Mac addresses in the given Mac group

Parameters:

mid - Mac group Id, tuple of (dataPath ID, SRC/DST, group ID)

Returns:

Set of Mac Addresses in the group currently

getMacGroups

Map<MacGroupId,MacGroup> getMacGroups(DataPathId dpid,
                                    MacGroup.Type type)

List Mac groups from the dataPath by type

Parameters:

dpid - dataPath ID

type - Type of Mac group, SRC/DST

Returns:

the hashmap containing all Mac groups on the dataPath with the type specified