Package org.onosproject.net.flow

Class DefaultFlowEntry

java.lang.Object

org.onosproject.net.flow.DefaultFlowRule

org.onosproject.net.flow.DefaultFlowEntry

All Implemented Interfaces:

FlowEntry, FlowRule, StoredFlowEntry, PiTranslatable

Direct Known Subclasses:

DefaultTypedFlowEntry

public class DefaultFlowEntry
extends DefaultFlowRule
implements StoredFlowEntry

Nested Class Summary

Nested classes/interfaces inherited from class org.onosproject.net.flow.DefaultFlowRule

DefaultFlowRule.Builder

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

FlowEntry.FlowEntryState, 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

Constructor Summary

Constructors

Constructor	Description
DefaultFlowEntry(FlowRule rule)
DefaultFlowEntry(FlowRule rule, int errType, int errCode)	Creates a flow entry of flow table specified with the flow rule, state, live type and statistic information.
DefaultFlowEntry(FlowRule rule, FlowEntry.FlowEntryState state)	Creates a flow entry based on specified flow rule and state.
DefaultFlowEntry(FlowRule rule, FlowEntry.FlowEntryState state, long lifeSecs, long packets, long bytes)
DefaultFlowEntry(FlowRule rule, FlowEntry.FlowEntryState state, long life, TimeUnit lifeTimeUnit, long packets, long bytes)	Creates a flow entry of flow table specified with the flow rule, state and statistic information.
DefaultFlowEntry(FlowRule rule, FlowEntry.FlowEntryState state, long life, TimeUnit lifeTimeUnit, FlowEntry.FlowLiveType liveType, long packets, long bytes)	Creates a flow entry of flow table specified with the flow rule, state and statistic information.
DefaultFlowEntry(FlowRule rule, FlowEntry.FlowEntryState state, long lifeSecs, FlowEntry.FlowLiveType liveType, long packets, long bytes)	Creates a flow entry of flow table specified with the flow rule, state, live type and statistic information.

Method Summary

Modifier and Type	Method	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 timeUnit)	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.
void	setBytes(long bytes)	Number of bytes seen by this rule.
void	setLastSeen()	Sets the last active epoch time.
void	setLife(long life)	Sets how long this entry has been entered in the system.
void	setLife(long life, TimeUnit timeUnit)	Sets how long this entry has been entered in the system.
void	setLiveType(FlowEntry.FlowLiveType liveType)	Sets the flow live type, i.e., IMMEDIATE, SHORT, MID, LONG.
void	setPackets(long packets)	Number of packets seen by this entry.
void	setState(FlowEntry.FlowEntryState newState)	Sets the new state for this entry.
FlowEntry.FlowEntryState	state()	Returns the flow entry state.
String	toString()

Methods inherited from class org.onosproject.net.flow.DefaultFlowRule

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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

DefaultFlowEntry

public DefaultFlowEntry(FlowRule rule,
                        FlowEntry.FlowEntryState state,
                        long life,
                        TimeUnit lifeTimeUnit,
                        long packets,
                        long bytes)

Creates a flow entry of flow table specified with the flow rule, state and statistic information.

Parameters:

rule - the flow rule

state - the flow state

life - the duration second of flow

lifeTimeUnit - life time unit

packets - the number of packets of this flow

bytes - the the number of bytes of this flow

DefaultFlowEntry

public DefaultFlowEntry(FlowRule rule,
                        FlowEntry.FlowEntryState state,
                        long life,
                        TimeUnit lifeTimeUnit,
                        FlowEntry.FlowLiveType liveType,
                        long packets,
                        long bytes)

Creates a flow entry of flow table specified with the flow rule, state and statistic information.

Parameters:

rule - the flow rule

state - the flow state

life - the duration second of flow

lifeTimeUnit - life time unit

liveType - the flow live type, i.e., IMMEDIATE, SHORT, MID, LONG

packets - the number of packets of this flow

bytes - the the number of bytes of this flow

DefaultFlowEntry

public DefaultFlowEntry(FlowRule rule,
                        FlowEntry.FlowEntryState state,
                        long lifeSecs,
                        FlowEntry.FlowLiveType liveType,
                        long packets,
                        long bytes)

Creates a flow entry of flow table specified with the flow rule, state, live type and statistic information.

Parameters:

rule - the flow rule

state - the flow state

lifeSecs - the duration second of flow

liveType - the flow live type, i.e., IMMEDIATE, SHORT, MID, LONG

packets - the number of packets of this flow

bytes - the the number of bytes of this flow

DefaultFlowEntry

public DefaultFlowEntry(FlowRule rule,
                        FlowEntry.FlowEntryState state,
                        long lifeSecs,
                        long packets,
                        long bytes)

DefaultFlowEntry

public DefaultFlowEntry(FlowRule rule)

DefaultFlowEntry

public DefaultFlowEntry(FlowRule rule,
                        FlowEntry.FlowEntryState state)

Creates a flow entry based on specified flow rule and state.

Parameters:

rule - to use as base

state - of the flow entry

DefaultFlowEntry

public DefaultFlowEntry(FlowRule rule,
                        int errType,
                        int errCode)

Creates a flow entry of flow table specified with the flow rule, state, live type and statistic information.

Parameters:

rule - the flow rule

errType - the error type

errCode - the error code

Method Detail

life

public long life()

Description copied from interface: FlowEntry

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

Specified by:

life in interface FlowEntry

Returns:

number of seconds

life

public long life(TimeUnit timeUnit)

Description copied from interface: FlowEntry

Returns the time this flow rule has been applied.

Specified by:

life in interface FlowEntry

Parameters:

timeUnit - time unit the result will be converted to

Returns:

time in the requested TimeUnit

liveType

public FlowEntry.FlowLiveType liveType()

Description copied from interface: FlowEntry

Gets the flow live type for this entry.

Specified by:

liveType in interface FlowEntry

Returns:

flow live type

packets

public long packets()

Description copied from interface: FlowEntry

Returns the number of packets this flow rule has matched.

Specified by:

packets in interface FlowEntry

Returns:

number of packets

bytes

public long bytes()

Description copied from interface: FlowEntry

Returns the number of bytes this flow rule has matched.

Specified by:

bytes in interface FlowEntry

Returns:

number of bytes

state

public FlowEntry.FlowEntryState state()

Description copied from interface: FlowEntry

Returns the flow entry state.

Specified by:

state in interface FlowEntry

Returns:

flow entry state

lastSeen

public long lastSeen()

Description copied from interface: FlowEntry

When this flow entry was last deemed active.

Specified by:

lastSeen in interface FlowEntry

Returns:

epoch time of last activity

setLastSeen

public void setLastSeen()

Description copied from interface: StoredFlowEntry

Sets the last active epoch time.

Specified by:

setLastSeen in interface StoredFlowEntry

setState

public void setState(FlowEntry.FlowEntryState newState)

Description copied from interface: StoredFlowEntry

Sets the new state for this entry.

Specified by:

setState in interface StoredFlowEntry

Parameters:

newState - new flow entry state.

setLife

public void setLife(long life)

Description copied from interface: StoredFlowEntry

Sets how long this entry has been entered in the system.

Specified by:

setLife in interface StoredFlowEntry

Parameters:

life - seconds

setLife

public void setLife(long life,
                    TimeUnit timeUnit)

Description copied from interface: StoredFlowEntry

Sets how long this entry has been entered in the system.

Specified by:

setLife in interface StoredFlowEntry

Parameters:

life - time

timeUnit - unit of time

setLiveType

public void setLiveType(FlowEntry.FlowLiveType liveType)

Description copied from interface: StoredFlowEntry

Sets the flow live type, i.e., IMMEDIATE, SHORT, MID, LONG.

Specified by:

setLiveType in interface StoredFlowEntry

Parameters:

liveType - flow live type

setPackets

public void setPackets(long packets)

Description copied from interface: StoredFlowEntry

Number of packets seen by this entry.

Specified by:

setPackets in interface StoredFlowEntry

Parameters:

packets - a long value

setBytes

public void setBytes(long bytes)

Description copied from interface: StoredFlowEntry

Number of bytes seen by this rule.

Specified by:

setBytes in interface StoredFlowEntry

Parameters:

bytes - a long value

errType

public int errType()

Description copied from interface: FlowEntry

Indicates the error type.

Specified by:

errType in interface FlowEntry

Returns:

an integer value of the error

errCode

public int errCode()

Description copied from interface: FlowEntry

Indicates the error code.

Specified by:

errCode in interface FlowEntry

Returns:

an integer value of the error

toString

public String toString()

Overrides:

toString in class DefaultFlowRule