hpievents man page

hpievents — An openhpi sample application that polls for events.

Synopsis

hpievents [ -D <value> ] [-N host[:port]] [-C <cfgfile>] [ -t BLOCK|SAHPI_TIMEOUT_BLOCK|n ] [ -d -X -h ]
hpievents [--domain=nn] [--host=host[:port]] [--cfgfile=file]
          [--timeout=BLOCK|SAHPI_TIMEOUT_BLOCK|n ] [--discover] [--debug] [--help]

Description

hpievents polls for events in an opened HPI session. User can specify wait time for the event. User can also select the order between hpi resource (resource event) discovery and hpi event subscription.

If no domain or host is selected, hpievents polls for events in the default domain as specified in the openhpiclient.conf file.

Options

Help Options

-h, --help
Show help options

Application Options

-t n|BLOCK, --timeout=n|BLOCK
Wait n seconds for event or infinite wait (BLOCK)
-d, --discover
Call saHpiDiscover() after saHpiSubscribe()
-D nn, --domain=nn
Select domain id nn
-X, --debug
Display debug messages
-N "host[:port]", --host="host[:port]"
Open session to the domain served by the daemon at the specified URL (host:port). This option overrides the OPENHPI_DAEMON_HOST and OPENHPI_DAEMON_PORT environment variables. If host contains ':' (for example IPv6 address) then enclose it in square brackets. For example: "[::1]" or "[::1]:4743".
-C "file", --cfgfile="file"
Use passed file as client configuration file. This option overrides the OPENHPICLIENT_CONF environment variable.

HPI APIs uniquely used in this application

SaErrorT SAHPI_API saHpiSubscribe (
SAHPI_IN SaHpiSessionIdT SessionId );

SaErrorT SAHPI_API saHpiUnsubscribe (
SAHPI_IN SaHpiSessionIdT SessionId );

SaErrorT SAHPI_API saHpiEventGet (
SAHPI_IN SaHpiSessionIdT SessionId,
SAHPI_IN SaHpiTimeoutT Timeout,
SAHPI_OUT SaHpiEventT *Event,
SAHPI_INOUT SaHpiRdrT *Rdr,
SAHPI_INOUT SaHpiRptEntryT *RptEntry,
SAHPI_INOUT SaHpiEvtQueueStatusT *EventQueueStatus );

See Also

hpi_shell
hpialarms      hpigensimdata  hpireset       hpitop
hpidomain      hpiinv         hpisensor      hpitree
hpiel          hpionIBMblade  hpisettime     hpiwdt
hpifan         hpipower       hpithres       hpixml
ohdomainlist   ohhandler      ohparam

Authors

Authors of this man page:

Peter D Phan (pdphan@users.sourceforge.net)
Ulrich Kleber (ulikleber@users.sourceforge.net)
Anton Pak (avpak@users.sourceforge.net)

Info

2015-09-14 3.6.1 OpenHPI