Previous section.

Systems Management; Event Management Service (XEMS)
Copyright © 1997 The Open Group

Event Objects

CMIP Event Objects

CMIP defines an event report which is used to report an event to a peer CMISE-service-user. Its arguments are given in the structures on the following page. 
 

EventReply ::= SEQUENCE {
    eventType                EventTypeId,
    eventReplyInfo           [8] ANY DEFINED by eventType OPTIONAL }    

EventReportArgument ::= SEQUENCE {
    managedObjectClass       ObjectClass,
    managedObjectInstance    ObjectInstance,
    eventTime                [5] IMPLICIT GeneralizedTime OPTIONAL,
    eventType                EventTypeId,
    eventInfo                [8] ANY DEFINED BY eventType OPTIONAL }

EventReportResult ::= SEQUENCE {
    managedObjectClass       mapping ObjectClass OPTIONAL,
    managedObjectInstance    ObjectInstance OPTIONAL,
    currentTime              [5] IMPLICIT GeneralizedTime OPTIONAL,
    eventReply               EventReply OPTIONAL }

EventTypeId ::= CHOICE {
    globalFor                [6] IMPLICIT OBJECT IDENTIFIER,
    localFor                 [7] IMPLICIT INTEGER }

ObjectClass ::= CHOICE {
    globalFor                [6] IMPLICIT OBJECT IDENTIFIER,
    localFor                 [7] IMPLICIT INTEGER }

ObjectInstance ::= CHOICE {
    distinguishedName        [2] IMPLICIT DistinguishedName,
    nonSpecificFor           [3] IMPLICIT OCTET STRING,
    localDistinguishedName   [4] IMPLICIT RDNSequence }

AttributeValueAssertion ::= SEQUENCE  {
    attributeType            AttributeType ,
    attributeValue           AttributeValue    }

Attribute ::= SEQUENCE    {
    type                     AttributeType ,
    values                   SET OF AttributeValue   }

AttributeType ::= OBJECT IDENTIFIER

AttributeValue ::= ANY

RelativeDistinguishedName ::= SET OF AttributeValueAssertion

RDNSequence ::= SEQUENCE OF RelativeDistinguishedName

DistinguishedName ::= RDNSequence

Name ::= CHOICE  {
    rDNSequence              RDNSequence   }

These arguments map down to the set of basic attribute types listed in Mapping for CMIS Event Structure Data Types .

Attribute Name Attribute Format Description
ANY es_c_attr_bytes Supports the capability to pass arbitrary ASN.1 syntax
GeneralizedTime ems_c_attr_utc Time event occurred
OBJECT IDENTIFIER es_c_attr_ulong_int* Sequence of integers to uniquely identify anything
INTEGER es_c_attr_ulong_int Integer value
OCTET STRING es_c_attr_char_string Sequence of bytes

Table: Mapping for CMIS Event Structure Data Types

DCE SVC Event Objects

DCE SVC is used to route error messages from DCE Applications. Messages can be routed by severity to any of the following locations:

An additional routing was added to also send messages to XEMS. This section shows the apping from an SVC message to an XEMS Event.

The data declaration of the SVC data structure is as follows: 

 

typedef struct dce_svc_prolog_s_t {
    dce_svc_handle_t   handle;
    int                version;
    utc_t              t;
    const char         *argtypes;
    unsigned32         table_index;
    unsigned32         attributes;
    unsigned32         message_index;
    char               *format;
    const char         *file;
    char               progname[dce_svc_c_progname_buffsize];
    int                line;
    pthread_t          thread_id;
} *dce_svc_prolog_t;

Index Attribute Name Attribute Format Description
0 version es_c_attr_ulong_int Version number of interface that generated message
1 t es_c_attr_utc Time message was written
2 argtypes es_c_attr_char_string The format-specifier string for the message
3 table_index es_c_attr_ulong_int Subcomponent table index
4 attributes es_c_attr_ulong_int Message attributes, OR'd together
5 essage_index ems_c_attr_ulong_int Index number of message in message table
6 format ems_c_attr_char_string Format argument values for the message
7 file es_c_attr_char_string Name of the source file where message came from
8 progname ems_c_attr_char_string Program name where message came from
9 line es_c_attr_ulong_int Line number where message came from
10 threadid es_c_attr_ulong_int Thread ID of the thread that output the message
11 component_name ems_c_attr_char_string SVC Component name of program that output message
12 sc_name ems_c_attr_char_string Name SVC SubComponent that output message
13 attribute.debug es_c_attr_ushort_int Debug attribute of message
14 attribute.severity es_c_attr_ushort_int SVC Severity of message
15 attribute.actroute es_c_attr_ulong_int Action/Routing attribute of message
16     SVC Argument 1
       
  . . .    
       
15+N     SVC Argument N

Table: Mapping for a DCE SVC Message

EMS Event Objects

The following set of events are supplied by the Event Service itself. These events are supplied to notify when defined event service events occur.

Event Service Action Notification Event

This event type is supplied when the event service performs an action such as register a consumer or supplier, or add or delete an event type or filter.

Type:
e433700c-b3cd-11cf-9550-10005a4f3556

Name:
EventServiceActionNotification

Size:
33

Index Attribute Name Attribute Format Description
0 EStype es_c_attr_ushort_int Event Service event type
1 name ems_c_attr_char_string Name depending on EStype
2 uuid es_c_attr_uuid UUID depending on EStype

Table: Event Service Action Notification Event

Possible values for EStype are:

ESconsumerRegister

notifies when a consumer has registered.

name
Consumer name

uuid
Consumer uuid

ESsupplierRegister

notifies when a supplier has registered.

name
Supplier name

uuid
Supplier uuid

ESconsumerConnect

notifies when a consumer has connected.

name
Consumer name

uuid
Consumer uuid

ESconsumerUnregister

notifies when a consumer has unregistered.

name
Consumer name

uuid
Consumer uuid

ESeventTypeAdd

notifies when an even type has been added.

name
Event Type name

uuid
Event Type uuid

ESeventTypeDelete

notifies when an event type has been deleted.

name
Event Type name

uuid
Event Type uuid

ESfilterAdd

notifies when a filter was added.

name
Filter name

uuid
Filter uuid

ESfilterDelete

notifies when a filter has been deleted.

name
Filter name

uuid
Filter uuid

ESfilterModify

notifies when a filter has been modified.

name
Filter name

uuid
Filter uuid

Event Service Queue Full Event

This event type is supplied when the event service event queue is full. If the consumer name is specified, then that consumer's event queue is full, otherwise, the event service event queue is full.

Type:
e67902ca-bfce-11cf-a767-10005a4f3556

Name:
EventServiceQueueFull

Size:
33.

Index Attribute Name Attribute Format Description
0 QueueSize es_c_attr_ulong_int Event queue size (that is, number of events in Queue)
1 name ems_c_attr_char_string Consumer name if this is a consumer event queue
2 uuid es_c_attr_uuid Consumer UUID

Table: Event Service Queue Full Event

Event Service Error Event

This event type is supplied when an event service error occurs. The error message is a printf style of error message with the arguments being in attributes 1 thru N.

Type:
ff3c46fe-bfcf-11cf-b01c-10005a4f3556

Name:
EventServiceError

Size:
1.

Index Attribute Name Attribute Format Description
0 ErrorMsg es_c_attr_char_string Event Service error message
1     Event Service error message Argument 1
       
  . . .    
       
1+N     Event Service error message Argument N

Table: Event Service Error Event

Event Service Undelivered Event Notification Event

This event type is supplied when the event service fails to deliver an event to a consumer.

Type:
ff3c46ff-bfcf-11cf-b01c-10005a4f3556

Name:
UndeliveredEvent Notification

Size:
 

Index Attribute Name Attribute Format Description
0 Consumer ems_c_attr_bytes The consumer structure, ems_consumer_t, associated with the targeted consumer
1 Supplier es_c_attr_bytes The supplier structure, es_supplier_t, associated with the supplier of the undeliverable event
2 EventHeader es_c_attr_bytes The event header structure, es_hdr_t, associated with the undeliverable event

Table: Event Service Undelivered Event Notification Event

Event Service Consumer Filter Group Changes

This event type is supplied when the event service changes the number of filters associated with an active consumer filter group.

Type:
ff3c4701-bfcf-11cf-b01c-10005a4f3556

Name:
ConsumerFilterGroup

Size:
 

Index Attribute Name Attribute Format Description
0 type es_c_attr_ushort_int Action type
1 name ems_c_attr_char_string Consumer name
2 uuid es_c_attr_uuid Consumer uuid
3 index es_c_attr_ulong_int Event handler function index for a given consumer environment

Possible values for action types are:

ESaddFilterToGroup

notifies when an event filter has been added to a group.

ESdeleteFilterFromGroup

notifies when an event filter has been deleted from a group.

Event Service Consumer Interest

This event type is supplied when the event service changes the number of consumers interested in an event type.

Type:
ff3c4700-bfcf-11cf-b01c-10005a4f3556

Name:
ConsumerEventInterest

Size:
 

Index Attribute Name Attribute Format Description
0 name ems_c_attr_char_string Event type name
1 uuid es_c_attr_uuid Event type uuid
2 count es_c_attr_ulong_int Number of interested consumers

SNMP Event Objects

SNMP defines an event report which is used to report an event from a SNMP proxy manager.

Index Attribute Name Attribute Format Description
0 version es_c_attr_ulong_int SNMP Version number that generated this message
1 community ems_c_attr_byte_string Community name
2 Trap-PDU es_c_attr_ulong_int Indicates this message carries a Trap PDU
3 enterprise es_c_attr_char_string MIB II sysObjectID of object generating trap
4 agent-addr es_c_attr_byte_string NetworkAddress of object generating this trap
5 generic-trap es_c_attr_long_int A generic SNMP trap type
6 specific-trap es_c_attr_long_int Specific code is present even if generic trap is not enterpriseSpecific
7 tie-stamp ems_c_attr_ulong_int Time elapsed since the last (re)initialization of entity and the generation of this trap
8+N variable-bindings   Message specific VarBindList begins1

Table: Event Service Report Event from SNMP Proxy Manager
Table: Mapping for SNMP Event Structure Data Types

SNMP XEMS Description
Primitive Types2 Attribute Format  
INTEGER Any
es_c_attr_xxxx_int 		Variable. The ASN.1 encoding for each variable provides its size information.
OCTET STRING es_c_attr_byte_string May contain value X'00'.
OBJECT IDENTIFIER es_c_attr_char_string An ASN.1 OBJECT IDENTIFIER is a sequence of integer literals in dot notation which are used to traverse the ISO global object tree.
NULL es_c_attr_???? ANSI NULL. Currently this EMS does not include this type.
     
Constructor Types    
     
SEQUENCE Any ems attribute An SNMP list; Implicit in XEMS schema
SEQUENCE OF
<entry> 		Any ems attribute Where <entry> resolves to an SNMP list. An SNMP table; Implicit in XEMS schema.
     
Defined Types    
     
IpADDRESS es_c_attr_byte_string Currently, only the Internet protocol faily is defined for NetworkAddress CHOICE.
Counter es_c_attr_ulong_int Non-negative integer which monotonically increases and wraps to 0 after reaching maximum value (2^32-1).
Gauge es_c_attr_ulong_int Non-negative integer which may increase or decrease, but which latches at a maximum value (2^32-1).
TimeTicks ems_c_attr_ulong_int Non-negative integer which counts the tie in hundredths of a second since some epoch.
Opaque es_c_attr_bytes Supports the capability to pass arbitrary ASN.1 syntax.
     
Common Constructs    
     
RequestId es_c_attr_long_int Used by SNMP application entities to correlate incoming responses with outstanding requests.
ErrorStatus es_c_attr_long_int A non-zero instance is used to indicate an exception.
ErrorIndex es_c_attr_ulong_int May provide additional information by indicating which variable in a list caused the exception.
VarBind es attribute Name Value pair. An SNMP name implies the data type. XEMS ems_attr_value_t component of ems_c_attribute_t stores value and data type.
VarBindList XEMS Event Schema Simple list of Name Value pairs.
     
PDUs    
     
GetRequest-PDU es_c_attr_ulong_int 0
GetNextRequest-PDU es_c_attr_ulong_int 1
GetResponse-PDU es_c_attr_ulong_int 2
SetRequest-PDU es_c_attr_ulong_int 3
Trap-PDU es_c_attr_ulong_int 4
     
MIB II    
     
DisplayString es_c_attr_char_string Printable display string restricted to the NVT ASCII character set defined in RFC 854.
PhysAddress es_c_attr_byte_string Used to represent edia- or physical-level addresses.

Footnotes

1.
An SNMP OBJECT IDENTIFIER type which needs to be applied to ARRAY of Integer. Currently this EMS does not support this construct.

2.
Types derived from IETF RFC 1155 (SMI Primitive , Constructor and Defined Types), RFC 1157 (SNMP Common Constructs), and RFC 1213 (MIB II).*Types derived from IETF RFC 1155 (SMI Primitive, Constructor and Defined Types), RFC 1157 (SNMP Common Constructs), and RFC 1213 (MIB II).

Why not acquire a nicely bound hard copy?
Click here to return to the publication details or order a copy of this publication.

Contents Next section Index