Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-inventory-manager / 67b788dcbdd960d665e632b4a97e5dea0c97f456
commit67b788dcbdd960d665e632b4a97e5dea0c97f456[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Tue Nov 29 13:09:01 2016 -0500
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Thu Dec 15 10:55:38 2016 -0500
tree7c461f00d90a1a451cff6977c851affadd9cf5f7
parent9007432a86723dd6542dc3ee1289598537d916e1 [diff]
Move filters.hpp to events.hpp

Prepare for a more generalized event description framework enabling
event classes other than DBus signal matches.  Filters become a
sub-concept within that framework so rename the file.

Change-Id: I0be9f9997239aad6e798ca16055aedc3e1233994
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
2 files changed
tree: 7c461f00d90a1a451cff6977c851affadd9cf5f7
  1. example/
  2. test/
  3. xyz/
  4. .gitignore
  5. actions.hpp
  6. app.cpp
  7. bootstrap.sh
  8. configure.ac
  9. events.hpp
  10. generated.mako.cpp
  11. LICENSE
  12. Makefile.am
  13. manager.cpp
  14. manager.hpp
  15. pimgen.py
  16. README.md
  17. utils.hpp
  18. xyz.openbmc_project.Inventory.Manager.cpp
README.md

Phosphor Inventory Manager (PIM) is an implementation of the xyz.openbmc_project.Inventory.Manager DBus interface, and supporting tools. PIM uses a combination of build-time YAML files and run-time calls to the Notify method of the Manager interface to provide a generalized inventory state management solution.

YAML

PIM includes a YAML parser (pimgen.py). For PIM to do anything useful, a set of YAML files must be provided externally that tell it what to do. An example can be found in the examples directory.

The following top level YAML tags are supported:

  • description - An optional description of the file.
  • events - One or more events that PIM should monitor.

events

Supported event tags are:

  • name - A globally unique event name.
  • type - The event type. Supported types are: match.
  • action - The response to the event.

Subsequent tags are defined by the event type.

action

Supported action tags are:

  • type - The action to perform.
  • args - An optional list of arguments to pass to the action.
    • value - The argument value.
    • type - The argument type (defaults to string if unspecified).

The available actions provided by PIM are:

  • noop - A non-action.
  • destroyObject - Destroy the specified DBus object.

match

Supported match tags are:

  • signature - A DBus match specification.
  • filter - A filter to apply when a match occurs.

filter

Supported filter tags are:

  • type - The filter to use.
  • args - An optional list of arguments to pass to the filter.
    • value - The argument value.
    • type - The argument type (defaults to string if unspecified).

The available filters provided by PIM are:

  • none - A non-filter.
  • propertyChangedTo - Only match events when the specified property has the specified value.

Building

After running pimgen.py, build PIM using the following steps:

    ./bootstrap.sh
    ./configure ${CONFIGURE_FLAGS}
    make

To clean the repository run:

 ./bootstrap.sh clean