OVXFlowEntry (OpenVirteX 0.0.2 API)

java.lang.Object
- net.onrc.openvirtex.elements.datapath.OVXFlowEntry

All Implemented Interfaces:

Comparable<OVXFlowEntry>
```
public class OVXFlowEntry
extends Object
implements Comparable<OVXFlowEntry>
```
Class representing a virtual flow entry - a wrapper for FlowMods that enables the flow table to do matching on contents.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DISJOINT`
`static int`	`EQUAL`
`protected OVXFlowMod`	`flowmod`
`static int`	`INTERSECT`
`protected long`	`newcookie`
`static int`	`SUBSET`
`static int`	`SUPERSET`

Constructor Summary

Constructors
Constructor and Description

OVXFlowEntry()

OVXFlowEntry(OVXFlowMod fm, long cookie)

Constructors
Constructor and Description
`OVXFlowEntry()`
`OVXFlowEntry(OVXFlowMod fm, long cookie)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compare(OFMatch omatch, boolean strict)` Compares this entry against another, and tries to determine if it is a superset, subset, or equal to it.
`int`	`compareTo(OVXFlowEntry other)`
`boolean`	`equals(Object obj)`
`boolean`	`equals(OVXFlowMod other)` compare this FlowEntry to another FlowMod.
`List<OFAction>`	`getActionsList()`
`long`	`getCookie()` Gets the cookie associated with this flow entry.
`OVXFlowMod`	`getFlowMod()`
`OFMatch`	`getMatch()`
`long`	`getNewCookie()`
`short`	`getOutport()`
`short`	`getPriority()`
`int`	`hashCode()`
`OVXFlowEntry`	`setFlowMod(OVXFlowMod fm)`
`OVXFlowEntry`	`setNewCookie(Long cookie)` Sets the new cookie for this entry.
`Map<String,Object>`	`toMap()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EQUAL
```
public static final int EQUAL
```
    See Also:
    Constant Field Values
  - SUPERSET
```
public static final int SUPERSET
```
    See Also:
    Constant Field Values
  - SUBSET
```
public static final int SUBSET
```
    See Also:
    Constant Field Values
  - INTERSECT
```
public static final int INTERSECT
```
    See Also:
    Constant Field Values
  - DISJOINT
```
public static final int DISJOINT
```
    See Also:
    Constant Field Values
  - flowmod
```
protected OVXFlowMod flowmod
```
  - newcookie
```
protected long newcookie
```
- Constructor Detail
  - OVXFlowEntry
```
public OVXFlowEntry()
```
  - OVXFlowEntry
```
public OVXFlowEntry(OVXFlowMod fm,
            long cookie)
```
- Method Detail
  - compare
```
public int compare(OFMatch omatch,
          boolean strict)
```
    Compares this entry against another, and tries to determine if it is a superset, subset, or equal to it. Required for non-strict matching and overlap checking
    For each field, we first check wildcard equality. If both are equal, they are either 1 or 0. If 0, we further check for field equality. If the fields are not equal, the flow entries are considered disjoint and we exit comparison.
    If both wildcards are not equal, we check if one subsumes the other.
    The result is tracked for each field in three ints - equality, superset, and subset. At the end, either 1) one of the ints are 0x3fffff, or 2) none are.
    
    Parameters:
    omatch - The other FlowEntry to compare this one against.
    strict - whether FlowMod from which the match came was strict or not.
    
    Returns:
    Union enum representing the relationship
  - getMatch
```
public OFMatch getMatch()
```
    Returns:
    original OFMatch
  - getOutport
```
public short getOutport()
```
    Returns:
    the virtual output port
  - getPriority
```
public short getPriority()
```
  - getFlowMod
```
public OVXFlowMod getFlowMod()
```
  - setFlowMod
```
public OVXFlowEntry setFlowMod(OVXFlowMod fm)
```
  - getNewCookie
```
public long getNewCookie()
```
    Returns:
    The new (Physical) cookie
  - setNewCookie
```
public OVXFlowEntry setNewCookie(Long cookie)
```
    Sets the new cookie for this entry.
    
    Parameters:
    cookie - the cookie
  - getCookie
```
public long getCookie()
```
    Gets the cookie associated with this flow entry.
    
    Returns:
    The original (virtual) cookie
  - getActionsList
```
public List<OFAction> getActionsList()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(OVXFlowMod other)
```
    compare this FlowEntry to another FlowMod.
    
    Parameters:
    other -
    
    Returns:
  - compareTo
```
public int compareTo(OVXFlowEntry other)
```
    Specified by:
    
    compareTo in interface Comparable<OVXFlowEntry>
  - toMap
```
public Map<String,Object> toMap()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class OVXFlowEntry

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EQUAL

SUPERSET

SUBSET

INTERSECT

DISJOINT

flowmod

newcookie

Constructor Detail

OVXFlowEntry

OVXFlowEntry

Method Detail

compare

getMatch

getOutport

getPriority

getFlowMod

setFlowMod

getNewCookie

setNewCookie

getCookie

getActionsList

hashCode

equals

equals

compareTo

toMap

toString