@Beta
public interface PiPipeconfService
Modifier and Type | Method and Description |
---|---|
void |
bindToDevice(PiPipeconfId pipeconfId,
DeviceId deviceId)
Signals that the given pipeconf is associated to the given infrastructure
device.
|
String |
getMergedDriver(DeviceId deviceId,
PiPipeconfId pipeconfId)
Returns the name of a driver that is equivalent to the base driver of the
given device plus all the pipeline-specific behaviors exposed by the
given pipeconf (previously registered using
register(PiPipeconf) ). |
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.
|
void register(PiPipeconf pipeconf) throws IllegalStateException
pipeconf
- a pipeconfIllegalStateException
- if the same pipeconf identifier is already
registered.void remove(PiPipeconfId pipeconfId) throws IllegalStateException
pipeconfId
- a pipeconfIdIllegalStateException
- if the same pipeconf identifier is already
registered.Iterable<PiPipeconf> getPipeconfs()
Optional<PiPipeconf> getPipeconf(PiPipeconfId id)
id
- a pipeconf identifiervoid bindToDevice(PiPipeconfId pipeconfId, DeviceId deviceId)
ofDevice(DeviceId)
pipeconfId
- a pipeconf identifierdeviceId
- a device identifierString getMergedDriver(DeviceId deviceId, PiPipeconfId pipeconfId)
register(PiPipeconf)
). If such driver does not exist, this method
creates one and registers is with all necessary ONOS subsystems, such
that the returned name can be used to retrieve the driver instance using
DriverResolver.getDriver(String)
.
This method needs to be called on all nodes of the cluster that wants to use such merged driver.
Returns null if such merged driver cannot be created.
deviceId
- a device identifierpipeconfId
- a pipeconf identifierOptional<PiPipeconfId> ofDevice(DeviceId deviceId)
deviceId
- device identifier