ham_entity_condition_state()

Updated: May 06, 2022

Used by an entity to notify the HAM of a state transition

Synopsis:

#include <ha/ham.h>

int ham_entity_condition_state(
                         ham_entity_t *ehdl,
                         unsigned tostate,
                         unsigned flags );


Arguments:

ehdl
The HAM entity handle you want to report the transition to.
tostate
The value indicating the transitional state.
flags
Currently not used.

Library:

libham

Description:

This function enables an entity to report a transition to the HAM; the value tostate indicates the transitional state. The HAM in turn triggers a condition state event for this entity, and will search for matching subscribers for this event and execute all associated actions. For more details of the matching mechanisms refer to the API documentation for ham_condition_state().

Returns:

0
Success.
-1
An error occurred (errno is set).

Errors:

EBADF
Couldn't connect to the HAM.
EINVAL
The handle specified in ehdl is invalid.

The connection to the HAM is invalid. This happens when the process that opened the connection (using ham_connect()) and the process that's calling this function are not the same.

ENOENT
There's no entity by the given handle (ehdl).

In addition to the above errors, the HAM returns any error it encounters while servicing this request.

Classification:

QNX Neutrino

Safety:  
Cancellation point No
Interrupt handler No
Signal handler No
Thread Yes