Package org.onosproject.net.behaviour
Interface PiRegisterProgrammable
-
- All Superinterfaces:
Behaviour
,HandlerBehaviour
@Beta public interface PiRegisterProgrammable extends HandlerBehaviour
Protocol-independent register programmable device behaviour.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.concurrent.CompletableFuture<java.util.Collection<PiRegisterCell>>
readAllRegisterCells()
Gets all of the register cells from the device.java.util.concurrent.CompletableFuture<PiRegisterCell>
readRegisterCell(PiRegisterCellId cellId)
Gets the register cell given the register cell ID from the device.java.util.concurrent.CompletableFuture<java.util.Collection<PiRegisterCell>>
readRegisterCells(java.util.Set<PiRegisterCellId> cellIds)
Gets the register cells given the collection of cellIds from the device.java.util.concurrent.CompletableFuture<java.util.Collection<PiRegisterCell>>
readRegisterCells(PiRegisterId registerId)
Gets all of the register cells given register ID from the device.java.util.concurrent.CompletableFuture<java.lang.Boolean>
writeRegisterCell(PiRegisterCell entry)
Write a register cell of this device.-
Methods inherited from interface org.onosproject.net.driver.HandlerBehaviour
handler, setHandler
-
-
-
-
Method Detail
-
writeRegisterCell
java.util.concurrent.CompletableFuture<java.lang.Boolean> writeRegisterCell(PiRegisterCell entry)
Write a register cell of this device.- Parameters:
entry
- register entry- Returns:
- Completable future with result of the operation
-
readRegisterCell
java.util.concurrent.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
java.util.concurrent.CompletableFuture<java.util.Collection<PiRegisterCell>> readRegisterCells(java.util.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
java.util.concurrent.CompletableFuture<java.util.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
java.util.concurrent.CompletableFuture<java.util.Collection<PiRegisterCell>> readAllRegisterCells()
Gets all of the register cells from the device.- Returns:
- completable future with the collection of register cells
-
-