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()).
InboundPacket	mapInboundPacket(DeviceId deviceId, PiPacketOperation packetInOperation) Returns a InboundPacket equivalent to the given packet operation.
Collection<PiPacketOperation>	mapOutboundPacket(OutboundPacket packet) Returns a collection of packet operations equivalent to the given OutboundPacket.
Optional<Criterion.Type>	mapPiHeaderFieldId(PiHeaderFieldId headerFieldId) Returns the criterion type that is equivalent to the given protocol-independent header field identifier, if present.
Optional<Integer>	mapPiTableId(PiTableId piTableId) Returns a numeric table id (as in FlowRule.tableId()) equivalent to the given protocol-independent table id.
PiAction	mapTreatment(TrafficTreatment treatment, PiTableId piTableId) Returns an action of a protocol-independent pipeline that is functionally equivalent to the given ONOS traffic treatment for the given table.

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

mapPiTableId

Optional<Integer> mapPiTableId(PiTableId piTableId)

Returns a numeric table id (as in FlowRule.tableId()) equivalent to the given protocol-independent table id. If not present, it means that the given protocol-independent table id refers to a table that does not exist, or that cannot be used for flow rule operations.

Parameters:

piTableId - protocol-independent table id

Returns:

numeric table id

mapTreatment

PiAction mapTreatment(TrafficTreatment treatment,
                      PiTableId piTableId)
               throws PiPipelineInterpreter.PiInterpreterException

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

Parameters:

treatment - a ONOS traffic treatment

piTableId - PI table identifier

Returns:

an action object

Throws:

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

mapOutboundPacket

Collection<PiPacketOperation> mapOutboundPacket(OutboundPacket packet)
                                         throws PiPipelineInterpreter.PiInterpreterException

Returns a collection of packet operations equivalent to the given OutboundPacket.

Parameters:

packet - a ONOS outbound packet

Returns:

a collection of packet operations

Throws:

PiPipelineInterpreter.PiInterpreterException - if the packet treatments cannot be mapped to any metadata

mapInboundPacket

InboundPacket mapInboundPacket(DeviceId deviceId,
                               PiPacketOperation packetInOperation)
                        throws PiPipelineInterpreter.PiInterpreterException

Returns a InboundPacket equivalent to the given packet operation.

Parameters:

deviceId - the device that originated the packet-in

packetInOperation - the packet operation

Returns:

an ONOS inbound packet

Throws:

PiPipelineInterpreter.PiInterpreterException - if the port can't be extracted from the packet metadata