evmevent.5 (2010 09)

ManualsBrandsHP ManualsSoftwareHP-UX Manpages

EvmEvent(5) EvmEvent(5)

NAME

EvmEvent - structure of an EVM Event

DESCRIPTION

An EVM event is a self-contained data structure, which can be manipulated and accessed using EVM API

functions. Application code can:

• Create, duplicate and destroy an event.

• Set and retrieve the values of standard data items contained within the event.

• Add variable data items to the event, and set and retrieve their values.

• Post the event to the EVM daemon for distribution to subscribers.

• Read events from an open ﬁle descriptor.

• Write events to an open ﬁle descriptor.

Command line utilities are provided that allow users access to these capabilities.

The Contents of an Event

The event structure includes two types of data items:

1. Standard data items, with predeﬁned names

2. Variable data items, with names and types deﬁned at the time they are added to the event

When you create an event you can include as many data items as you like. When you post the event,

the API functions automatically add the standard items which pertain to the current environment,

such as the host name and timestamp.

Standard Data Items

Standard data items are those which are commonly required in an event, and which are understood and

may be acted upon by EVM. The following table is a list of the standard data items that may be con-

tained in an event. The identiﬁer is the keyword used to post, display, or format the item.

Data item/Id Description

Event Name

Names the event. Must match a name in the

daemon’s template database if the event is to be

posted.

NAME

Time Posted

UNIX system time when the ﬁrst occurrence of this

event was generated.

TIMESTAMP

Repeat Count

Number of instances of the same event that have

been combined into a single stored event. The

Time Posted and Last Timestamp items indicate

when the ﬁrst and last instances of the event were

posted.

REPEAT_COUNT

Last Timestamp

If Repeat Count is present and non-zero, the sys-

tem time when the latest occurrence of this event

was generated.

LAST_TIMESTAMP

Event Identiﬁer

Identiﬁes the event. See the description following

this table.

EVENT_ID

Kernel Only

HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1

Summary of content (6 pages)

PAGE 1
EvmEvent(5) EvmEvent(5) NAME EvmEvent - structure of an EVM Event DESCRIPTION An EVM event is a self-contained data structure, which can be manipulated and accessed using EVM API functions. Application code can: • Create, duplicate and destroy an event. • Set and retrieve the values of standard data items contained within the event. • Add variable data items to the event, and set and retrieve their values. • Post the event to the EVM daemon for distribution to subscribers.
PAGE 2
EvmEvent(5) KERNEL_ONLY Process ID PID Parent Process ID PPID User name USER_NAME A Priority PRIORITY eA I18N catalog I18N_CATALOG I18N message set id I18N_SET_ID I18N message id I18N_MSG_ID Format FORMAT Reference REF EvmEvent(5) If present and EvmTRUE for an event generated in the kernel, the event is not propagated from the kernel to user space. PID of the process which posted the event. PID of the parent of the process which posted the event. Name of the owner of the posting process.
PAGE 3
EvmEvent(5) EvmEvent(5) • Each posted event receives an unsigned integer event identification number, with a value greater by one than that of the previous event posted through the same EVM daemon. • The event identifier of the first event posted after the daemon is started or restarted is zero. • The event identifier wraps back to zero after it has reached its maximum value. • If a daemon receives an event that already contains an identifier, it does not generate a new identifier for the event.
PAGE 4
EvmEvent(5) 0 None EvmEvent(5) Application Priority 0 should be used for events that are specifically intended to be subscribed to by programs, and are not expected to be interesting to administrators. Catalog Name and Message Set Identification If you plan to internationalize your events, you need to supply an I18N catalog file containing the format strings for all of the events, and include the name of the file in the event.
PAGE 5
EvmEvent(5) Type Identification EvmTYPE_BOOLEAN EvmTYPE_CHAR EvmTYPE_INT16 EvmTYPE_INT32 EvmTYPE_INT64 EvmTYPE_UINT8 EvmTYPE_UINT16 EvmTYPE_UINT32 EvmTYPE_UINT64 EvmTYPE_FLOAT EvmTYPE_DOUBLE EvmTYPE_STRING EvmTYPE_OPAQUE EvmEvent(5) Remarks 8-bit integer 8-bit character 16-bit signed integer 32-bit signed integer 64-bit signed integer 8-bit unsigned integer 16-bit unsigned integer 32-bit unsigned integer 64-bit unsigned integer 32-bit floating point value 64-bit floating point value Null-terminated chara
PAGE 6
(Notes) A (Notes) eA 6 Hewlett-Packard Company −1− HP-UX 11i Version 3: September 2010