org.onosproject.net.pi.model

Interface PiPipelineInterpreter

All Superinterfaces:

Behaviour, HandlerBehaviour

@Beta
public interface PiPipelineInterpreter
extends HandlerBehaviour

An interpreter of a protocol-independent pipeline model.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PiPipelineInterpreter.PiInterpreterException Signals that an error was encountered while executing the interpreter.

Method Summary

Modifier and Type	Method and Description
Optional<PiHeaderFieldId>	mapCriterionType(Criterion.Type type) Returns the protocol-independent header field identifier that is equivalent to the given criterion type, if present.
Optional<PiTableId>	mapFlowRuleTableId(int flowRuleTableId) Returns a protocol-independent table id equivalent to the given numeric table id (as in FlowRule.tableId()).
Optional<Criterion.Type>	mapPiHeaderFieldId(PiHeaderFieldId headerFieldId) Returns the criterion type that is equivalent to the given protocol-independent header field identifier, if present.
PiTableAction	mapTreatment(TrafficTreatment treatment, PiPipeconf pipeconf) Returns a table action of a protocol-independent pipeline that is functionally equivalent to the given ONOS traffic treatment for the given pipeline configuration.

Methods inherited from interface org.onosproject.net.driver.HandlerBehaviour

handler, setHandler

Methods inherited from interface org.onosproject.net.driver.Behaviour

data, setData

Method Detail

mapCriterionType

Optional<PiHeaderFieldId> mapCriterionType(Criterion.Type type)

Returns the protocol-independent header field identifier that is equivalent to the given criterion type, if present. If not present, it means that the given criterion type is not supported by this interpreter.

Parameters:

type - criterion type

Returns:

optional header field identifier

mapPiHeaderFieldId

Optional<Criterion.Type> mapPiHeaderFieldId(PiHeaderFieldId headerFieldId)

Returns the criterion type that is equivalent to the given protocol-independent header field identifier, if present. If not present, it means that the given field identifier is not supported by this interpreter.

Parameters:

headerFieldId - header field identifier

Returns:

optional criterion type

mapFlowRuleTableId

Optional<PiTableId> mapFlowRuleTableId(int flowRuleTableId)

Returns a protocol-independent table id equivalent to the given numeric table id (as in FlowRule.tableId()). If not present, it means that the given numeric table id cannot be mapped to any table of the pipeline model.

Parameters:

flowRuleTableId - a numeric table id

Returns:

a protocol-independent table id

mapTreatment

PiTableAction mapTreatment(TrafficTreatment treatment,
                           PiPipeconf pipeconf)
                    throws PiPipelineInterpreter.PiInterpreterException

Returns a table action of a protocol-independent pipeline that is functionally equivalent to the given ONOS traffic treatment for the given pipeline configuration.

Parameters:

treatment - a ONOS traffic treatment

pipeconf - a pipeline configuration

Returns:

a table action object

Throws:

PiPipelineInterpreter.PiInterpreterException - if the treatment cannot be mapped to any table action