Package org.onosproject.net.pi.runtime

Class PiMulticastGroupEntryHandle

java.lang.Object

org.onosproject.net.pi.runtime.PiHandle

org.onosproject.net.pi.runtime.PiPreEntryHandle

org.onosproject.net.pi.runtime.PiMulticastGroupEntryHandle

@Beta
public final class PiMulticastGroupEntryHandle
extends PiPreEntryHandle

Global identifier of a PI multicast group entry applied to the packet replication engine of a device, uniquely defined by a device ID, and group ID.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
int	groupId()	Returns the multicast group ID associated with this handle.
int	hashCode()
static PiMulticastGroupEntryHandle	of(DeviceId deviceId, int groupId)	Creates a new handle for the given device ID and PI multicast group ID.
static PiMulticastGroupEntryHandle	of(DeviceId deviceId, PiMulticastGroupEntry entry)	Creates a new handle for the given device ID and PI multicast group entry.
PiPreEntryType	preEntryType()	Returns the type of PRE entry associated with this handle.
java.lang.String	toString()

Methods inherited from class org.onosproject.net.pi.runtime.PiPreEntryHandle

entityType

Methods inherited from class org.onosproject.net.pi.runtime.PiHandle

deviceId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static PiMulticastGroupEntryHandle of(DeviceId deviceId,
                                             int groupId)

Creates a new handle for the given device ID and PI multicast group ID.

Parameters:

deviceId - device ID

groupId - multicast group ID

Returns:

PI multicast group entry handle

of

public static PiMulticastGroupEntryHandle of(DeviceId deviceId,
                                             PiMulticastGroupEntry entry)

Creates a new handle for the given device ID and PI multicast group entry.

Parameters:

deviceId - device ID

entry - PI multicast group entry

Returns:

PI multicast group entry handle

groupId

public int groupId()

Returns the multicast group ID associated with this handle.

Returns:

group ID

preEntryType

public PiPreEntryType preEntryType()

Description copied from class: PiPreEntryHandle

Returns the type of PRE entry associated with this handle.

Specified by:

preEntryType in class PiPreEntryHandle

Returns:

PRE entry type

hashCode

public int hashCode()

Specified by:

hashCode in class PiHandle

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in class PiHandle

toString

public java.lang.String toString()

Specified by:

toString in class PiHandle