org.onosproject.net.behaviour

Interface Pipeliner

All Superinterfaces:

Behaviour, HandlerBehaviour

public interface Pipeliner
extends HandlerBehaviour

Behaviour for handling various pipelines.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCUMULATOR_ENABLED Accumulator enabled property.

Method Summary

Modifier and Type	Method and Description
void	filter(FilteringObjective filterObjective) Installs the filtering rules onto the device.
void	forward(ForwardingObjective forwardObjective) Installs the forwarding rules onto the device.
List<String>	getNextMappings(NextGroup nextGroup) Retrieves a mapping of the nextObjective to the groups in the dataplane, and returns it in a form that can be displayed on the CLI.
void	init(DeviceId deviceId, PipelinerContext context) Initializes the driver with context required for its operation.
void	next(NextObjective nextObjective) Installs the next hop elements into the device.

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

handler, setHandler

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

data, setData

Field Detail

ACCUMULATOR_ENABLED

static final String ACCUMULATOR_ENABLED

Accumulator enabled property. Determines whether the accumulator is enabled. The accumulator is assumed to be disabled if this property is undefined. If enabled, the pipeliner will try to accumulate objectives and create batches of flow rules when possible.

See Also:

Constant Field Values

Method Detail

init

void init(DeviceId deviceId,
          PipelinerContext context)

Initializes the driver with context required for its operation.

Parameters:

deviceId - the deviceId

context - processing context

filter

void filter(FilteringObjective filterObjective)

Installs the filtering rules onto the device.

Parameters:

filterObjective - a filtering objective

forward

void forward(ForwardingObjective forwardObjective)

Installs the forwarding rules onto the device.

Parameters:

forwardObjective - a forwarding objective

next

void next(NextObjective nextObjective)

Installs the next hop elements into the device.

Parameters:

nextObjective - a next objectives

getNextMappings

List<String> getNextMappings(NextGroup nextGroup)

Retrieves a mapping of the nextObjective to the groups in the dataplane, and returns it in a form that can be displayed on the CLI. Typically group-ids are returned for groups with multiple buckets, where each list element represents a bucket. For nextObjectives that are converted to flow-actions, an empty list is returned.

Parameters:

nextGroup - representation of the nextObjective. This representation is stored in the distributed group store

Returns:

a list of preformatted strings representing group information, or an empty list if no groups were created