Package org.onosproject.net.driver
Driver
is a representation of a
specific family of entities (devices, links, etc.) which supports set of
behaviour classes
. Default
implementation is provided by the platform and allows DriverProviders to
add different behaviour implementations via DriverService.
DriverData
is a container for data
learned about an entity. It is associated with a specific
Driver
and provides set of behaviours
for talking about an entity. A default
implementation provided by platform and has mutable key/value store for use by
implementations of behaviours
.
DriverHandler
is an entity used as a
context to interact with a device. It has a peer
DriverData
instance, which is used to
store information learned about a device. It also
provides set of behaviours
for talking to a device.
DriverService
can be used to query the
inventory of device drivers and their behaviours, while the
DriverAdminService
allows adding/removing
drivers and managing behaviour implementations.
DriverProvider
is an entity capable
of add/removing drivers and supplying and managing behaviour
implementations. A default implementation is provided by the framework along
with a loader utility
to
create a driver provider from an XML file structured as follows:
<drivers> <driver name=“...” [manufacturer="..." hwVersion="..." swVersion="..."]> <behaviour api="..." impl="..."/> ... [<property name=“key”>value</key>] ... </driver> ... </drivers>
-
Interface Summary Interface Description Behaviour Representation of a facet of behaviour that can be used to talk about an entity (in context ofDriverData
) or to an entity (in context ofDriverHandler
).BehaviourClassResolver Entity capable of resolving a class using its name.DefaultDriverProviderService Deprecated. in Kingfisher release (1.10)DeviceConnect Abstraction of handler behaviour used to set-up and tear-down connections with a device.Driver Representation of a specific family of device drivers.DriverAdminService Service for managing drivers and driver behaviour implementations.DriverData Container for data about an entity, e.g.DriverHandler Representation of context for interacting with a device.DriverListener Entity capable of receiving driver related events.DriverPrimordialResolver Entity capable of resolving a driver using the primordial information of the manufacturer, hardware name/version and software version.DriverProvider Represents entity capable of providing device drivers and their behaviours.DriverRegistry Service for obtaining drivers and driver behaviour implementations.DriverResolver Entity capable of resolving a driver using its name.DriverService Service for obtaining drivers and driver behaviour implementations.HandlerBehaviour Representation of a facet of behaviour that can be used to interact with an entity (in context ofDriverHandler
).Projectable Abstraction of an entity capable of being projected as another entity. -
Class Summary Class Description AbstractBehaviour Base implementation of a driver behaviour.AbstractDriverLoader Abstract bootstrapper for loading and registering driver definitions that are dependent on the default driver definitions.AbstractHandlerBehaviour Base implementation of a driver handler behaviour.AbstractIndependentDriverLoader Abstract bootstrapper for loading and registering driver definitions that are independent from the default driver definitions.DefaultDriver Default implementation of extensible driver.DefaultDriverData Default implementation of driver data descriptor.DefaultDriverHandler Default implementation of driver handler.DefaultDriverProvider Default driver provider implementation.DriverEvent Driver configuration change event.XmlDriverLoader Utility capable of reading driver configuration XML resources and producing a device driver provider as a result. -
Enum Summary Enum Description DriverEvent.Type Type of driver events.