RtecEventData Struct Reference

User defined Event Data. More...

import "RtecDefaultEventData.idl";

Collaboration diagram for RtecEventData:

Collaboration graph
[legend]
List of all members.

Public Attributes

long pad1
 Add padding to align the octet sequence contents.

EventPayload payload
 Octet sequence payload.

any any_value
 Use a CORBA any type as payload.


Detailed Description

User defined Event Data.

This structure defines the default payload in TAO's Real-time Event Service.

Users wanting maximum flexibility can use an Any, users that only have one type of event may use structures, other users may preffer union, trying to strike a balance between performance and flexibility. Users willing to implement their own marshalling may use a sequence of octets.

The Event Service is completely transparent as to the contents of this structure.

Definition at line 41 of file RtecDefaultEventData.idl.


Member Data Documentation

any RtecEventData::any_value
 

Use a CORBA any type as payload.

Definition at line 72 of file RtecDefaultEventData.idl.

long RtecEventData::pad1
 

Add padding to align the octet sequence contents.

This fields ensures that the contents of the octet sequence following are always aligned to an 8-byte boundary. Such alignment allows application developers to implement custom demarshaling from the octet sequence without requiring any data copies.

This is how this works:

  • The last field in the header is an 8-byte unsigned long, hence the header finishes on an 8 byte boundary.
    • The pad1 long has 4 bytes.
  • The length in the octet sequence adds another 4 bytes.
  • Thus the data in the octet sequence starts on an 8 bytes boundary too.

Definition at line 60 of file RtecDefaultEventData.idl.

EventPayload RtecEventData::payload
 

Octet sequence payload.

This is the payload used more often by high-performance applications.

Definition at line 67 of file RtecDefaultEventData.idl.


The documentation for this struct was generated from the following file:
Generated on Thu Nov 9 13:14:17 2006 for TAO_RTEvent by doxygen 1.3.6