org.onosproject.net.pi.runtime

Class PiTableEntry

java.lang.Object

org.onosproject.net.pi.runtime.PiTableEntry

@Beta
public final class PiTableEntry
extends Object

Table entry in a protocol-independent pipeline.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PiTableEntry.Builder

Method Summary

Modifier and Type	Method and Description
PiTableAction	action() Returns the action of this table entry.
static PiTableEntry.Builder	builder() Returns a table entry builder.
long	cookie() Returns the cookie of this table entry.
boolean	equals(Object o)
Optional<PiFieldMatch>	fieldMatch(PiHeaderFieldId fieldId) If present, returns the field match associated with the given header field identifier.
Collection<PiFieldMatch>	fieldMatches() Returns an immutable view of the field matches of this table entry.
int	hashCode()
Optional<Integer>	priority() Returns the priority of this table entry, if present.
PiTableId	table() Returns the table where this entry is installed.
Optional<Double>	timeout() Returns the timeout in seconds of this table entry, if present.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

table

public PiTableId table()

Returns the table where this entry is installed.

Returns:

table identifier

fieldMatches

public Collection<PiFieldMatch> fieldMatches()

Returns an immutable view of the field matches of this table entry.

Returns:

collection of field matches

fieldMatch

public Optional<PiFieldMatch> fieldMatch(PiHeaderFieldId fieldId)

If present, returns the field match associated with the given header field identifier.

Parameters:

fieldId - field identifier

Returns:

optional field match

action

public PiTableAction action()

Returns the action of this table entry.

Returns:

action

cookie

public long cookie()

Returns the cookie of this table entry.

Returns:

cookie

priority

public Optional<Integer> priority()

Returns the priority of this table entry, if present. If the priority value is not present, then this table entry has no explicit priority.

Returns:

optional priority

timeout

public Optional<Double> timeout()

Returns the timeout in seconds of this table entry, if present. If the timeout value is not present, then this table entry is meant to be permanent.

Returns:

optional timeout value in seconds

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static PiTableEntry.Builder builder()

Returns a table entry builder.

Returns:

a new builder