org.onosproject.net.behaviour

Interface PiRegisterProgrammable

All Superinterfaces:

Behaviour, HandlerBehaviour

@Beta
public interface PiRegisterProgrammable
extends HandlerBehaviour

Protocol-independent register programmable device behaviour.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Collection<PiRegisterCell>>	readAllRegisterCells() Gets all of the register cells from the device.
CompletableFuture<PiRegisterCell>	readRegisterCell(PiRegisterCellId cellId) Gets the register cell given the register cell ID from the device.
CompletableFuture<Collection<PiRegisterCell>>	readRegisterCells(PiRegisterId registerId) Gets all of the register cells given register ID from the device.
CompletableFuture<Collection<PiRegisterCell>>	readRegisterCells(Set<PiRegisterCellId> cellIds) Gets the register cells given the collection of cellIds from the device.
CompletableFuture<Boolean>	writeRegisterCell(PiRegisterCell entry) Write a register cell of this device.

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

handler, setHandler

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

data, setData

Method Detail

writeRegisterCell

CompletableFuture<Boolean> writeRegisterCell(PiRegisterCell entry)

Write a register cell of this device.

Parameters:

entry - register entry

Returns:

Completable future with result of the operation

readRegisterCell

CompletableFuture<PiRegisterCell> readRegisterCell(PiRegisterCellId cellId)

Gets the register cell given the register cell ID from the device.

Parameters:

cellId - the register cell Id

Returns:

completable future with the register cell

readRegisterCells

CompletableFuture<Collection<PiRegisterCell>> readRegisterCells(Set<PiRegisterCellId> cellIds)

Gets the register cells given the collection of cellIds from the device.

Parameters:

cellIds - the collection of register cell Id

Returns:

completable future with the collection of register cells

readRegisterCells

CompletableFuture<Collection<PiRegisterCell>> readRegisterCells(PiRegisterId registerId)

Gets all of the register cells given register ID from the device.

Parameters:

registerId - the identifier of register

Returns:

completable future with the collection of register cells

readAllRegisterCells

CompletableFuture<Collection<PiRegisterCell>> readAllRegisterCells()

Gets all of the register cells from the device.

Returns:

completable future with the collection of register cells