org.onosproject.net.pi.runtime

Interface PiPipeconfService

@Beta
public interface PiPipeconfService

A service to manage the configurations of protocol-independent pipelines.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	bindToDevice(PiPipeconfId pipeconfId, DeviceId deviceId) Binds the given pipeconf to the given infrastructure device.
Optional<PiPipeconf>	getPipeconf(PiPipeconfId id) Returns the pipeconf instance associated with the given identifier, if present.
Iterable<PiPipeconf>	getPipeconfs() Returns all pipeconfs registered.
Optional<PiPipeconfId>	ofDevice(DeviceId deviceId) Returns the pipeconf identifier currently associated with the given device identifier, if present.
void	register(PiPipeconf pipeconf) Registers the given pipeconf.
void	remove(PiPipeconfId pipeconfId) Unregisters the Pipeconf identified by the given PiPipeconfId.

Method Detail

register

void register(PiPipeconf pipeconf)
       throws IllegalStateException

Registers the given pipeconf.

Parameters:

pipeconf - a pipeconf

Throws:

IllegalStateException - if the same pipeconf identifier is already registered.

remove

void remove(PiPipeconfId pipeconfId)
     throws IllegalStateException

Unregisters the Pipeconf identified by the given PiPipeconfId. Unregistering a Pipeconf removes it from the ONOS controller, thus making it un-capable of controlling (e.g installing flow rules) the devices that have the pipeconf's p4 program deployed. For now this method DOES NOT remove the p4 program from the devices.

Parameters:

pipeconfId - a pipeconfId

Throws:

IllegalStateException - if the same pipeconf identifier is already registered.

getPipeconfs

Iterable<PiPipeconf> getPipeconfs()

Returns all pipeconfs registered.

Returns:

a collection of pipeconfs

getPipeconf

Optional<PiPipeconf> getPipeconf(PiPipeconfId id)

Returns the pipeconf instance associated with the given identifier, if present. If not present, it means that no pipeconf with such identifier has been registered so far.

Parameters:

id - a pipeconf identifier

Returns:

an optional pipeconf

bindToDevice

CompletableFuture<Boolean> bindToDevice(PiPipeconfId pipeconfId,
                                        DeviceId deviceId)

Binds the given pipeconf to the given infrastructure device. As a result of this method call, if the given pipeconf exposes any pipeline-specific behaviours, those will be merged to the device's driver. Returns a completable future to provide async methods with a boolean if the merge of the drivers succeeded.

Parameters:

deviceId - a device identifier

pipeconfId - a pipeconf identifier

Returns:

a CompletableFuture with a boolean, true if operation succeeded

ofDevice

Optional<PiPipeconfId> ofDevice(DeviceId deviceId)

Returns the pipeconf identifier currently associated with the given device identifier, if present. If not present, it means no pipeconf has been associated with that device so far.

Parameters:

deviceId - device identifier

Returns:

an optional pipeconf identifier