org.onosproject.net.flow

Class DefaultTrafficTreatment.Builder

java.lang.Object

org.onosproject.net.flow.DefaultTrafficTreatment.Builder

All Implemented Interfaces:

TrafficTreatment.Builder

Enclosing class:

DefaultTrafficTreatment

public static final class DefaultTrafficTreatment.Builder
extends Object
implements TrafficTreatment.Builder

Builds a list of treatments following the following order. Modifications -> Group -> Output (including drop)

Method Summary

Modifier and Type	Method and Description
DefaultTrafficTreatment.Builder	add(Instruction instruction) Adds an instruction to the builder.
TrafficTreatment	build() Builds an immutable traffic treatment descriptor.
DefaultTrafficTreatment.Builder	copyTtlIn() Copy the TTL to inner protocol layer.
DefaultTrafficTreatment.Builder	copyTtlOut() Copy the TTL to outer protocol layer.
DefaultTrafficTreatment.Builder	decMplsTtl() Decrement MPLS TTL.
DefaultTrafficTreatment.Builder	decNwTtl() Decrement the TTL in IP header by one.
DefaultTrafficTreatment.Builder	deferred() Any instructions preceded by this method call will be deferred.
DefaultTrafficTreatment.Builder	drop() Adds a drop instruction.
DefaultTrafficTreatment.Builder	group(GroupId groupId) Sets the group ID.
DefaultTrafficTreatment.Builder	immediate() Any instructions preceded by this method call will be immediate.
DefaultTrafficTreatment.Builder	popMpls() Pops MPLS ether type.
DefaultTrafficTreatment.Builder	popMpls(int etherType) Pops MPLS ether type and set the new ethertype.
DefaultTrafficTreatment.Builder	popVlan() Pops outermost VLAN tag.
DefaultTrafficTreatment.Builder	punt() Adds a punt-to-controller instruction.
DefaultTrafficTreatment.Builder	pushMpls() Push MPLS ether type.
DefaultTrafficTreatment.Builder	pushVlan() Pushes a new VLAN tag.
DefaultTrafficTreatment.Builder	setEthDst(org.onlab.packet.MacAddress addr) Sets the dst l2 address.
DefaultTrafficTreatment.Builder	setEthSrc(org.onlab.packet.MacAddress addr) Sets the src l2 address.
DefaultTrafficTreatment.Builder	setIpDst(org.onlab.packet.IpAddress addr) Sets the dst l3 address.
DefaultTrafficTreatment.Builder	setIpSrc(org.onlab.packet.IpAddress addr) Sets the src l3 address.
DefaultTrafficTreatment.Builder	setLambda(short lambda) Sets the optical channel ID or lambda.
DefaultTrafficTreatment.Builder	setMpls(org.onlab.packet.MplsLabel mplsLabel) Sets the mpls label.
DefaultTrafficTreatment.Builder	setOutput(PortNumber number) Set the output port.
DefaultTrafficTreatment.Builder	setVlanId(org.onlab.packet.VlanId id) Sets the vlan id.
DefaultTrafficTreatment.Builder	setVlanPcp(Byte pcp) Sets the vlan priority.
DefaultTrafficTreatment.Builder	transition(FlowRule.Type type) Sets the next table type to transition to.
DefaultTrafficTreatment.Builder	transition(Integer tableId) Sets the next table id to transition to.
DefaultTrafficTreatment.Builder	wipeDeferred() Instructs the device to clear the deferred instructions set.
DefaultTrafficTreatment.Builder	writeMetadata(long metadata, long metadataMask) Writes metadata to associate with a packet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

add

public DefaultTrafficTreatment.Builder add(Instruction instruction)

Description copied from interface: TrafficTreatment.Builder

Adds an instruction to the builder.

Specified by:

add in interface TrafficTreatment.Builder

Parameters:

instruction - an instruction

Returns:

a treatment builder

drop

public DefaultTrafficTreatment.Builder drop()

Description copied from interface: TrafficTreatment.Builder

Adds a drop instruction.

Specified by:

drop in interface TrafficTreatment.Builder

Returns:

a treatment builder

punt

public DefaultTrafficTreatment.Builder punt()

Description copied from interface: TrafficTreatment.Builder

Adds a punt-to-controller instruction.

Specified by:

punt in interface TrafficTreatment.Builder

Returns:

a treatment builder

setOutput

public DefaultTrafficTreatment.Builder setOutput(PortNumber number)

Description copied from interface: TrafficTreatment.Builder

Set the output port.

Specified by:

setOutput in interface TrafficTreatment.Builder

Parameters:

number - the out port

Returns:

a treatment builder

setEthSrc

public DefaultTrafficTreatment.Builder setEthSrc(org.onlab.packet.MacAddress addr)

Description copied from interface: TrafficTreatment.Builder

Sets the src l2 address.

Specified by:

setEthSrc in interface TrafficTreatment.Builder

Parameters:

addr - a macaddress

Returns:

a treatment builder

setEthDst

public DefaultTrafficTreatment.Builder setEthDst(org.onlab.packet.MacAddress addr)

Description copied from interface: TrafficTreatment.Builder

Sets the dst l2 address.

Specified by:

setEthDst in interface TrafficTreatment.Builder

Parameters:

addr - a macaddress

Returns:

a treatment builder

setVlanId

public DefaultTrafficTreatment.Builder setVlanId(org.onlab.packet.VlanId id)

Description copied from interface: TrafficTreatment.Builder

Sets the vlan id.

Specified by:

setVlanId in interface TrafficTreatment.Builder

Parameters:

id - a vlanid

Returns:

a treatment builder

setVlanPcp

public DefaultTrafficTreatment.Builder setVlanPcp(Byte pcp)

Description copied from interface: TrafficTreatment.Builder

Sets the vlan priority.

Specified by:

setVlanPcp in interface TrafficTreatment.Builder

Parameters:

pcp - a vlan priority

Returns:

a treatment builder

setIpSrc

public DefaultTrafficTreatment.Builder setIpSrc(org.onlab.packet.IpAddress addr)

Description copied from interface: TrafficTreatment.Builder

Sets the src l3 address.

Specified by:

setIpSrc in interface TrafficTreatment.Builder

Parameters:

addr - an ip

Returns:

a treatment builder

setIpDst

public DefaultTrafficTreatment.Builder setIpDst(org.onlab.packet.IpAddress addr)

Description copied from interface: TrafficTreatment.Builder

Sets the dst l3 address.

Specified by:

setIpDst in interface TrafficTreatment.Builder

Parameters:

addr - an ip

Returns:

a treatment builder

decNwTtl

public DefaultTrafficTreatment.Builder decNwTtl()

Description copied from interface: TrafficTreatment.Builder

Decrement the TTL in IP header by one.

Specified by:

decNwTtl in interface TrafficTreatment.Builder

Returns:

a treatment builder

copyTtlIn

public DefaultTrafficTreatment.Builder copyTtlIn()

Description copied from interface: TrafficTreatment.Builder

Copy the TTL to inner protocol layer.

Specified by:

copyTtlIn in interface TrafficTreatment.Builder

Returns:

a treatment builder

copyTtlOut

public DefaultTrafficTreatment.Builder copyTtlOut()

Description copied from interface: TrafficTreatment.Builder

Copy the TTL to outer protocol layer.

Specified by:

copyTtlOut in interface TrafficTreatment.Builder

Returns:

a treatment builder

pushMpls

public DefaultTrafficTreatment.Builder pushMpls()

Description copied from interface: TrafficTreatment.Builder

Push MPLS ether type.

Specified by:

pushMpls in interface TrafficTreatment.Builder

Returns:

a treatment builder.

popMpls

public DefaultTrafficTreatment.Builder popMpls()

Description copied from interface: TrafficTreatment.Builder

Pops MPLS ether type.

Specified by:

popMpls in interface TrafficTreatment.Builder

Returns:

a treatment builder.

popMpls

public DefaultTrafficTreatment.Builder popMpls(int etherType)

Description copied from interface: TrafficTreatment.Builder

Pops MPLS ether type and set the new ethertype.

Specified by:

popMpls in interface TrafficTreatment.Builder

Parameters:

etherType - an ether type

Returns:

a treatment builder.

setMpls

public DefaultTrafficTreatment.Builder setMpls(org.onlab.packet.MplsLabel mplsLabel)

Description copied from interface: TrafficTreatment.Builder

Sets the mpls label.

Specified by:

setMpls in interface TrafficTreatment.Builder

Parameters:

mplsLabel - MPLS label.

Returns:

a treatment builder.

decMplsTtl

public DefaultTrafficTreatment.Builder decMplsTtl()

Description copied from interface: TrafficTreatment.Builder

Decrement MPLS TTL.

Specified by:

decMplsTtl in interface TrafficTreatment.Builder

Returns:

a treatment builder

setLambda

public DefaultTrafficTreatment.Builder setLambda(short lambda)

Description copied from interface: TrafficTreatment.Builder

Sets the optical channel ID or lambda.

Specified by:

setLambda in interface TrafficTreatment.Builder

Parameters:

lambda - optical channel ID

Returns:

a treatment builder

group

public DefaultTrafficTreatment.Builder group(GroupId groupId)

Description copied from interface: TrafficTreatment.Builder

Sets the group ID.

Specified by:

group in interface TrafficTreatment.Builder

Parameters:

groupId - group ID

Returns:

a treatment builder

popVlan

public DefaultTrafficTreatment.Builder popVlan()

Description copied from interface: TrafficTreatment.Builder

Pops outermost VLAN tag.

Specified by:

popVlan in interface TrafficTreatment.Builder

Returns:

a treatment builder.

pushVlan

public DefaultTrafficTreatment.Builder pushVlan()

Description copied from interface: TrafficTreatment.Builder

Pushes a new VLAN tag.

Specified by:

pushVlan in interface TrafficTreatment.Builder

Returns:

a treatment builder.

transition

public DefaultTrafficTreatment.Builder transition(FlowRule.Type type)

Description copied from interface: TrafficTreatment.Builder

Sets the next table type to transition to.

Specified by:

transition in interface TrafficTreatment.Builder

Parameters:

type - the table type

Returns:

a treatement builder

transition

public DefaultTrafficTreatment.Builder transition(Integer tableId)

Description copied from interface: TrafficTreatment.Builder

Sets the next table id to transition to.

Specified by:

transition in interface TrafficTreatment.Builder

Parameters:

tableId - the table table

Returns:

a treatement builder

immediate

public DefaultTrafficTreatment.Builder immediate()

Description copied from interface: TrafficTreatment.Builder

Any instructions preceded by this method call will be immediate.

Specified by:

immediate in interface TrafficTreatment.Builder

Returns:

a treatment builder

deferred

public DefaultTrafficTreatment.Builder deferred()

Description copied from interface: TrafficTreatment.Builder

Any instructions preceded by this method call will be deferred.

Specified by:

deferred in interface TrafficTreatment.Builder

Returns:

a treatment builder

wipeDeferred

public DefaultTrafficTreatment.Builder wipeDeferred()

Description copied from interface: TrafficTreatment.Builder

Instructs the device to clear the deferred instructions set.

Specified by:

wipeDeferred in interface TrafficTreatment.Builder

Returns:

a treatment builder

writeMetadata

public DefaultTrafficTreatment.Builder writeMetadata(long metadata,
                                                     long metadataMask)

Description copied from interface: TrafficTreatment.Builder

Writes metadata to associate with a packet.

 
 new_metadata = (old_metadata &  ̃mask) | (value & mask)
 
 

Specified by:

writeMetadata in interface TrafficTreatment.Builder

Parameters:

metadata - the metadata to write

metadataMask - the masked bits for the value

Returns:

a treatment builder

build

public TrafficTreatment build()

Description copied from interface: TrafficTreatment.Builder

Builds an immutable traffic treatment descriptor.

If the treatment is empty when build() is called, it will add a default drop rule automatically. For a treatment that is actually empty, use DefaultTrafficTreatment.emptyTreatment().

Specified by:

build in interface TrafficTreatment.Builder

Returns:

traffic treatment