attnmgr_common.h File Reference

---

Detailed Description

ALP Attention common component definitions.

#include <time.h>
#include <hiker/types.h>
#include <hiker/sysclass.h>

Go to the source code of this file.

Data Structures
struct	_AlpNotifyEventAttnAlert
struct	_AlpAttnProp
Status subclasses
Definitions for the various attention components
#define	ALP_STATUS_ATTN   (ALP_CLASS_ATTN | 0x00010000)
	Status class for attention manager API.
#define	ALP_STATUS_ATTN_DML   (ALP_CLASS_ATTN | 0x00020000)
	Status class for attention manager DML.
#define	ALP_STATUS_ATTN_IPC   (ALP_CLASS_ATTN | 0x00030000)
	Status class for attention manager IPC.
Errors
#define	ALP_STATUS_ATTN_BAD_PARAM   (ALP_STATUS_ATTN | 0x00000100)
	An invalid parameter was passed to the function call.
#define	ALP_STATUS_ATTN_NO_MEMORY   (ALP_STATUS_ATTN | 0x00000200)
	Unable to allocate enough memory to complete the function call.
#define	ALP_STATUS_ATTN_INTERNAL_ERROR   (ALP_STATUS_ATTN | 0x00000300)
	An unexpected internal error occurred during the function call.
#define	ALP_STATUS_ATTN_NOT_FOUND   (ALP_STATUS_ATTN | 0x00000400)
	The requested item was not present.
Priority level definitions
#define	ALP_ATTN_PRIO_MAX   ALP_ATTN_PRIO_1
#define	ALP_ATTN_PRIO_MIN   ALP_ATTN_PRIO_5
#define	ALP_ATTN_PRIO_RANGE_LOWER   0
#define	ALP_ATTN_PRIO_RANGE_UPPER   255
enum	AlpAttnPriority {   ALP_ATTN_PRIO_NONE = -1, ALP_ATTN_PRIO_1 = 1, ALP_ATTN_PRIO_2 = 2, ALP_ATTN_PRIO_3 = 3,   ALP_ATTN_PRIO_4 = 4, ALP_ATTN_PRIO_5 = 5, ALP_ATTN_PRIO_NULL = 254, ALP_ATTN_PRIO_TEST = 255 }
	priority levels More...
Attention Alert Notifications
#define	ALP_NOTIFY_EVENT_ATTN_ALERT   "/alp/attn/alert/"
typedef _AlpNotifyEventAttnAlert	AlpNotifyEventAttnAlert
Common data structures
These are used by the various components of the Attention Manager.
typedef _AlpAttnProp	AlpAttnProp
	Attention Alert Property.
Typedefs
typedef AlpLuid	AlpAttnId
	type of an attn alert ID
typedef void *	AlpAttnAlertH
	opaque type holding an alert object
typedef void *	AlpAttnPropertyH
	opaque type holding a property object

---

Define Documentation

#define ALP_ATTN_PRIO_MAX   ALP_ATTN_PRIO_1

#define ALP_ATTN_PRIO_MIN   ALP_ATTN_PRIO_5

#define ALP_ATTN_PRIO_RANGE_LOWER   0

#define ALP_ATTN_PRIO_RANGE_UPPER   255

#define ALP_NOTIFY_EVENT_ATTN_ALERT   "/alp/attn/alert/"

#define ALP_STATUS_ATTN   (ALP_CLASS_ATTN | 0x00010000)

Status class for attention manager API.

#define ALP_STATUS_ATTN_BAD_PARAM   (ALP_STATUS_ATTN | 0x00000100)

An invalid parameter was passed to the function call.

#define ALP_STATUS_ATTN_DML   (ALP_CLASS_ATTN | 0x00020000)

Status class for attention manager DML.

#define ALP_STATUS_ATTN_INTERNAL_ERROR   (ALP_STATUS_ATTN | 0x00000300)

An unexpected internal error occurred during the function call.

#define ALP_STATUS_ATTN_IPC   (ALP_CLASS_ATTN | 0x00030000)

Status class for attention manager IPC.

#define ALP_STATUS_ATTN_NO_MEMORY   (ALP_STATUS_ATTN | 0x00000200)

Unable to allocate enough memory to complete the function call.

#define ALP_STATUS_ATTN_NOT_FOUND   (ALP_STATUS_ATTN | 0x00000400)

The requested item was not present.

---

Typedef Documentation

typedef struct _AlpAttnProp AlpAttnProp

Attention Alert Property. This structure is meant to hold a property for an attention alert. It currently consists of a name field to hold the property key and a value field to hold the property contents.

typedef struct _AlpNotifyEventAttnAlert AlpNotifyEventAttnAlert

---

Enumeration Type Documentation

enum AlpAttnPriority

priority levels Enumerator: ALP_ATTN_PRIO_NONE  No priority specified. ALP_ATTN_PRIO_1  Highest priority. ALP_ATTN_PRIO_2  ALP_ATTN_PRIO_3  ALP_ATTN_PRIO_4  ALP_ATTN_PRIO_5  Lowest priority. ALP_ATTN_PRIO_NULL  priority to sink alerts ALP_ATTN_PRIO_TEST  priority to test bad param

---