org.onosproject.net.flow

Interface FlowEntry

All Superinterfaces:

FlowRule, PiTranslatable

All Known Subinterfaces:

StoredFlowEntry, TypedStoredFlowEntry

All Known Implementing Classes:

DefaultFlowEntry, DefaultTypedFlowEntry

public interface FlowEntry
extends FlowRule

Represents a generalized match & action pair to be applied to an infrastructure device.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FlowEntry.FlowEntryState
static class	FlowEntry.FlowLiveType

Nested classes/interfaces inherited from interface org.onosproject.net.flow.FlowRule

FlowRule.Builder, FlowRule.FlowRemoveReason

Field Summary

Fields inherited from interface org.onosproject.net.flow.FlowRule

DEFAULT_TABLE, MAX_PRIORITY, MAX_TIMEOUT, MIN_PRIORITY

Method Summary

Modifier and Type	Method and Description
long	bytes() Returns the number of bytes this flow rule has matched.
int	errCode() Indicates the error code.
int	errType() Indicates the error type.
long	lastSeen() When this flow entry was last deemed active.
long	life() Returns the number of seconds this flow rule has been applied.
long	life(TimeUnit unit) Returns the time this flow rule has been applied.
FlowEntry.FlowLiveType	liveType() Gets the flow live type for this entry.
long	packets() Returns the number of packets this flow rule has matched.
FlowEntry.FlowEntryState	state() Returns the flow entry state.

Methods inherited from interface org.onosproject.net.flow.FlowRule

appId, deviceId, equals, exactMatch, groupId, hardTimeout, id, isPermanent, payLoad, priority, reason, selector, table, tableId, timeout, treatment

Method Detail

state

FlowEntry.FlowEntryState state()

Returns the flow entry state.

Returns:

flow entry state

life

long life()

Returns the number of seconds this flow rule has been applied.

Returns:

number of seconds

liveType

FlowEntry.FlowLiveType liveType()

Gets the flow live type for this entry.

Returns:

flow live type

life

long life(TimeUnit unit)

Returns the time this flow rule has been applied.

Parameters:

unit - time unit the result will be converted to

Returns:

time in the requested TimeUnit

packets

long packets()

Returns the number of packets this flow rule has matched.

Returns:

number of packets

bytes

long bytes()

Returns the number of bytes this flow rule has matched.

Returns:

number of bytes

lastSeen

long lastSeen()

When this flow entry was last deemed active.

Returns:

epoch time of last activity

errType

int errType()

Indicates the error type.

Returns:

an integer value of the error

errCode

int errCode()

Indicates the error code.

Returns:

an integer value of the error