org.onosproject.net.group

Interface Group

All Superinterfaces:

GroupDescription, PiTranslatable

All Known Subinterfaces:

StoredGroupEntry

All Known Implementing Classes:

DefaultGroup

public interface Group
extends GroupDescription, PiTranslatable

ONOS representation of group that is stored in the system.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Group.GroupState State of the group object in ONOS.

Nested classes/interfaces inherited from interface org.onosproject.net.group.GroupDescription

GroupDescription.Type

Method Summary

Modifier and Type	Method and Description
int	age() Obtains the age of a group.
long	bytes() Returns the number of bytes processed by this group.
int	failedRetryCount() Returns the count for the number of attempts at programming a failed group.
GroupId	id() Returns group identifier associated with a group object.
long	life() Returns the number of milliseconds this group has been alive.
long	packets() Returns the number of packets processed by this group.
long	referenceCount() Returns the number of flow rules or other groups reference this group.
Group.GroupState	state() Returns current state of a group object.

Methods inherited from interface org.onosproject.net.group.GroupDescription

appCookie, appId, buckets, deviceId, givenGroupId, type

Method Detail

id

GroupId id()

Returns group identifier associated with a group object.

Returns:

GroupId Group Identifier

state

Group.GroupState state()

Returns current state of a group object.

Returns:

GroupState Group State

life

long life()

Returns the number of milliseconds this group has been alive.

Returns:

number of millis

packets

long packets()

Returns the number of packets processed by this group.

Returns:

number of packets

bytes

long bytes()

Returns the number of bytes processed by this group.

Returns:

number of bytes

referenceCount

long referenceCount()

Returns the number of flow rules or other groups reference this group.

Returns:

number of flow rules or other groups pointing to this group

age

int age()

Obtains the age of a group. The age reflects the number of polling rounds the group has had a reference count of zero.

Returns:

the age of the group as an integer

failedRetryCount

int failedRetryCount()

Returns the count for the number of attempts at programming a failed group.

Returns:

the count for the number of failed attempts at programming this group