hpievents(1)

hpievents1

An openhpi sample application that polls for events.

Usage

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]

Overview

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 );

Releases

8 releases since Debian 6.0 (Squeeze); the text changed 7 times.

  1. 6.0
  2. 7
  3. 8
  4. 9
  5. 10
  6. 11
  7. 12
  8. 13

--cfgfile since Debian 9 (Stretch); --debug since Debian 9 (Stretch); --discover since Debian 9 (Stretch); --domain since Debian 9 (Stretch); --help since Debian 9 (Stretch); --host since Debian 9 (Stretch); --timeout since Debian 9 (Stretch); -C since Debian 9 (Stretch); -D since Debian 9 (Stretch); -N since Debian 9 (Stretch); -X since Debian 9 (Stretch); -d since Debian 9 (Stretch); -h since Debian 9 (Stretch); -t since Debian 9 (Stretch).