org.projectfloodlight.openflow.types

Class OFPortBitMap512

java.lang.Object

org.projectfloodlight.openflow.types.Masked<OFBitMask512>

org.projectfloodlight.openflow.types.OFPortBitMap512

All Implemented Interfaces:

Comparable<Masked<OFBitMask512>>, OFValueType<Masked<OFBitMask512>>, PrimitiveSinkable

@Immutable
public class OFPortBitMap512
extends Masked<OFBitMask512>

User-facing object representing a bitmap of ports that can be matched on. This is implemented by the custom BSN OXM type of_oxm_bsn_in_ports_512. You can call set() on the builder for all the Ports you want to match on and unset to exclude the port. Implementation note: to comply with the matching semantics of OXM (which is a logical "AND" not "OR") the underlying match uses a data format which is very unintuitive. The value is always 0, and the mask has the bits set for the ports that should NOT be included in the range. For the curious: We transformed the bitmap (a logical OR) problem into a logical AND NOT problem. We logically mean: Inport is 1 OR 3 We technically say: Inport IS NOT 2 AND IS NOT 4 AND IS NOT 5 AND IS NOT .... The second term cannot be represented in OXM, the second can. That said, all that craziness is hidden from the user of this object.

Usage

OFPortBitmap is meant to be used with MatchField BSN_IN_PORTS_512 in place of the raw type Masked<OFBitMask512>.

Example:

:

  OFPortBitMap portBitMap;
  Match.Builder matchBuilder;
  // initialize
  matchBuilder.setMasked(MatchField.BSN_IN_PORTS_512, portBitmap);
  

Author:

Andreas Wundsam <andreas.wundsam@bigswitch.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OFPortBitMap512.Builder

Field Summary

Fields inherited from class org.projectfloodlight.openflow.types.Masked

mask, value

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Iterable<OFPort>	getOnPorts()
int	hashCode()
boolean	isOn(OFPort port)
static OFPortBitMap512	of(OFBitMask512 mask)
static OFPortBitMap512	ofPorts(OFPort... ports)

Methods inherited from class org.projectfloodlight.openflow.types.Masked

applyMask, compareTo, getLength, getMask, getValue, matches, of, putTo, toString

Methods inherited from class java.lang.Object

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

Method Detail

isOn

public boolean isOn(OFPort port)

Parameters:

port - the port to check

Returns:

whether or not the given port is logically included in the match, i.e., whether a packet from in-port port be matched by this OXM.

ofPorts

public static OFPortBitMap512 ofPorts(OFPort... ports)

of

public static OFPortBitMap512 of(OFBitMask512 mask)

Parameters:

mask - the mask used to create the bitmap

Returns:

an OFPortBitmap based on the 'mask' part of an OFBitMask512, as, e.g., returned by the switch.

getOnPorts

public Iterable<OFPort> getOnPorts()

Returns:

iterating over all ports that are logically included in the match, i.e., whether a packet from in-port port be matched by this OXM.

equals

public boolean equals(Object obj)

Overrides:

equals in class Masked<OFBitMask512>

hashCode

public int hashCode()

Overrides:

hashCode in class Masked<OFBitMask512>