org.onosproject.net.behaviour

Interface PiPipelineProgrammable

All Superinterfaces:

Behaviour, HandlerBehaviour

@Beta
public interface PiPipelineProgrammable
extends HandlerBehaviour

Behavior to program the pipeline of a device that supports protocol-independence.

Method Summary

Modifier and Type	Method and Description
Optional<PiPipeconf>	getDefaultPipeconf() Returns the default pipeconf for this device, to be used when any other pipeconf is not available.
boolean	isPipeconfSet(PiPipeconf pipeconf) Returns true if the device is configured with the given pipeconf, false otherwise.
CompletableFuture<Boolean>	setPipeconf(PiPipeconf pipeconf) Writes the given pipeconf to the device, returns a completable future with true is the operations was successful, false otherwise.

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

handler, setHandler

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

data, setData

Method Detail

setPipeconf

CompletableFuture<Boolean> setPipeconf(PiPipeconf pipeconf)

Writes the given pipeconf to the device, returns a completable future with true is the operations was successful, false otherwise.

After the future has been completed, the device is expected to process data plane packets according to the written pipeconf.

Parameters:

pipeconf - pipeconf

Returns:

completable future set to true if the operation was successful, false otherwise

isPipeconfSet

boolean isPipeconfSet(PiPipeconf pipeconf)

Returns true if the device is configured with the given pipeconf, false otherwise.

This method is expected to always return true after successfully calling setPipeconf(PiPipeconf) with the given pipeconf.

Parameters:

pipeconf - pipeconf

Returns:

true if the device has the given pipeconf set, false otherwise

getDefaultPipeconf

Optional<PiPipeconf> getDefaultPipeconf()

Returns the default pipeconf for this device, to be used when any other pipeconf is not available.

Returns:

optional pipeconf