Syntax

    typedef struct EventBlockStruct 
    { 
       LONG   version;
       LONG   EBReserved1;
       LONG   EBReserved2;
       LONG   EBReserved3;
       void  *link;
       LONG   producerHandle;
       void   *producerWorkSpace;
       void   *consumingConsumer;
       LONG   eventDataLength;
       void   *eventData;
       BYTE   shortEventData[16];
       LONG   eventNotifyType;
       void  *userParameter;
       void  *parameter0;
       void  *parameter1;
       LONG   EBReserved4;
       LONG   EBReserved[1];
    } EventBlockDef;
    

Fields

version

The version of the event block. This allows the event block to be modified in the future, yet remain backwards compatible. It is initialized during NPA_Get_EventBlocks.

EBReserved1

Reserved by NWPA.

EBReserved2

Reserved by NWPA.

EBReserved3

Reserved by NWPA.

link

This field is used to chain multiple event blocks to each other. This field can be used by the producer, because link is not modified by the NEB during NPA_Send_Event.

producerHandle

This field should be filled in with the registrationHandle obtained by calling NPA_Register_With_EventBus as a producer.

producerWorkSpace

The field is defined to be used by the producer.

consumingConsumer

This field is filled in by the NEB with a token identifying the consumer that consumed the event (if the consumable bit was set on that consumer).

eventDataLength

Length in bytes of the event data. If eventData does not contain a pointer to data, set this to 0.

eventData

The event data or a pointer to the event data.

shortEventData

Custom data defined by the event type.

eventNotifyType

Valid only in esr, as defined by the parameter passed to NPA_Register_With_EventBus. Producers should not use this field when sending an event.

Event	Description
NOTIFY_ASYNCHRONOUS_CONSUMER	Notify an asynchronous consumer that an event was produced. parameter0 contains the consumer's security token (it might have been modified by event security authority). Returns OK or EVENT_CONSUMED (if the consumer's consumable bit was set.).
NOTIFY_ASYNC_CONSUMER_ UNREGISTRATION	Allows a security authority to be notified when a consumer is no longer registered to consume the event. parameter0 contains the producer's security token. parameter1 contains a token identifying the consumer.
NOTIFY_AUDITOR	Notify the auditor that an event was produced. parameter0 contains return codes from security authority and check consumers. Returns OK or DENY.
NOTIFY_CHECK_CONSUMER	Notify check consumer that an event was produced. parameter0 contains consumer's security token (it might have been modified by event security authority). Returns OK or DENY.
NOTIFY_CHECK_CONSUMER_ UNREGISTRATION	Allows a security authority to be notified when a consumer is no longer registered to consume the event. parameter0 contains the producer's security token. parameter1 contains a token identifying the consumer.
NOTIFY_DEBUGGER	Notify event debugger that an event was produced. Event debugger is also invoked for each of the other event types, after the appropriate consumer has been invoked.
NOTIFY_PRODUCER_UNREGISTRATION	Allows a security authority to be notified when a producer is no longer registered to produce the event. parameter0 contains the producers security token.
NOTIFY_SYNCHRONOUS_CONSUMER	Notify synchronous consumer that an event was produced. parameter0 contains consumer's security token (it might have been modified by event security authority). Returns OK or DENY.
NOTIFY_SYNC_CONSUMER_ UNREGISTRATION	Allows a security authority to be notified when a consumer is no longer registered to consume the event. parameter0 contains the producer's security token. parameter1 contains a token identifying the consumer. This should be the most commonly used eventType.
VALIDATE_ASYNC_CONSUMER_ REGISTRATION	Allows a security authority to authorize a consumer to register as an asynchronous consumer. parameter0 contains consumer's security token. parameter1 contains a token identifying the consumer. Returns OK or DENY.
VALIDATE_CHECK_CONSUMER_ REGISTRATION	Allows a security authority to authorize a consumer to register as a check consumer. parameter0 contains consumer's security token. parameter1 contains a token identifying the consumer. Returns OK or DENY.
VALIDATE_PRODUCER_REGISTRATION	Allows a security authority to authorize a producer to register to produce the event. parameter0 contains producers security token. Returns OK or DENY.
VALIDATE_SYNC_CONSUMER_ REGISTRATION	Allows a security authority to authorize a consumer to register as a synchronous consumer. parameter0 contains consumer's security token. parameter1 contains a token identifying the consumer. Returns OK or DENY.
VERIFY_ASYNC_CONSUMER	Allows a security authority to authorize an asynchronous consumer to receive a specific instance of an event. parameter0 contains consumer's security token. parameter1 contains a token identifying the consumer. Returns OK or DENY.
VERIFY_CHECK_CONSUMER	Allows a security authority to authorize a check consumer to receive a specific instance of an event. parameter0 contains consumer's security token. parameter1 contains a token identifying the consumer. Returns OK or DENY.
VERIFY_PRODUCER	Allows a security authority to authorize a producer to produce a specific instance of an event. parameter0 contains consumer's security token. Returns OK or DENY.
VERIFY_SYNC_CONSUMER	Allows a security authority to authorize a synchronous consumer to receive a specific instance of an event. parameter0 contains consumer's security token. parameter1 contains a token identifying the consumer. Returns OK or DENY.

userParameter

Valid only in esr, as defined by the parameter passed to NPA_Register_With_EventBus. This contains the userParameter passed into NPA_Register_With_EventBus during registration.

parameter0

Valid only in esr, as defined by the parameter passed to NPA_Register_With_EventBus. This field is defined as specified in eventNotifyType.

parameter1

Valid only in esr, as defined by the parameter passed to NPA_Register_With_EventBus. This field is defined as specified in eventNotifyType.

EBReserved4

Reserved by NWPA.

EBReserved[1]

Reserved by NWPA.