Package org.onosproject.net.flow
Interface TrafficTreatment
-
- All Known Implementing Classes:
DefaultTrafficTreatment
public interface TrafficTreatment
Abstraction of network traffic treatment.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
TrafficTreatment.Builder
Builder of traffic treatment entities.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<Instruction>
allInstructions()
Returns the list of all instructions in the treatment, both immediate and deferred.boolean
clearedDeferred()
Whether the deferred treatment instructions will be cleared by the device.java.util.List<Instruction>
deferred()
Returns the list of treatment instructions that will be applied further down the pipeline.java.util.List<Instruction>
immediate()
Returns the list of treatment instructions that will be applied immediately.Instructions.MeterInstruction
metered()
Returns the meter instruction if there is one.java.util.Set<Instructions.MeterInstruction>
meters()
Returns the meter instructions if there is any.Instructions.StatTriggerInstruction
statTrigger()
Returns the stat trigger instruction if there is one.Instructions.TableTypeTransition
tableTransition()
Returns the next table in the pipeline.Instructions.MetadataInstruction
writeMetadata()
Returns the metadata instruction if there is one.
-
-
-
Method Detail
-
deferred
java.util.List<Instruction> deferred()
Returns the list of treatment instructions that will be applied further down the pipeline.- Returns:
- list of treatment instructions
-
immediate
java.util.List<Instruction> immediate()
Returns the list of treatment instructions that will be applied immediately.- Returns:
- list of treatment instructions
-
allInstructions
java.util.List<Instruction> allInstructions()
Returns the list of all instructions in the treatment, both immediate and deferred.- Returns:
- list of treatment instructions
-
tableTransition
Instructions.TableTypeTransition tableTransition()
Returns the next table in the pipeline.- Returns:
- a table transition; may be null.
-
clearedDeferred
boolean clearedDeferred()
Whether the deferred treatment instructions will be cleared by the device.- Returns:
- a boolean
-
writeMetadata
Instructions.MetadataInstruction writeMetadata()
Returns the metadata instruction if there is one.- Returns:
- a metadata instruction that may be null
-
statTrigger
Instructions.StatTriggerInstruction statTrigger()
Returns the stat trigger instruction if there is one.- Returns:
- a stat trigger instruction; may be null.
-
metered
Instructions.MeterInstruction metered()
Returns the meter instruction if there is one.- Returns:
- a meter instruction that may be a null.
-
meters
java.util.Set<Instructions.MeterInstruction> meters()
Returns the meter instructions if there is any.- Returns:
- meter instructions that may be an empty set.
-
-