Broker 10.15 | webMethods Broker Documentation | webMethods Broker Client C API Programmer's Guide | Creating and Initializing Events | Envelope Fields | Read-only Envelope Fields
 
Read-only Envelope Fields
 
The connectionIntegrity Envelope Field
The pubNetAddr Envelope Field
The route Envelope Field
The following table shows the envelope fields used by the Broker which your application may retrieve, but not alter.
Note:
Attempting to retrieve an envelope field that has not been set will return a BrokerError with a major code set to AW_ERROR_FIELD_NOT_FOUND.
Envelope Field
Event Editor Type
Description
connectionIntegrity
unicode_string
Indicates whether or not the received event passed over an insecure link.
destId
unicode_string
Client ID of the event's recipient. This is used only with delivered events, described on Publishing and Delivering Events.
enqueueTime
date
The date and time that the Broker enqueued the event for the recipient.
pubDistinguishedName
unicode_string
The distinguished name of the Broker client that published the event using an SSL connection.
pubId
unicode_string
Client ID of the event's publisher. If the publishing client is connect to a different Broker than the recipient, the ID will be fully qualified (prefixed with the name of the publisher's Broker).
pubNetAddr
sequence of bytes
A sequence of bytes in string format that contains the IP address and port number of the event's publisher. See The pubNetAddr Envelope Field for more information on this field.
pubSeqn
long
A 64-bit value representing the event's publish sequence number. The use of publish sequence numbers is described in Using Sequence Numbers.
pubLabel
short[]
Set by the Broker for an event published by a client which has an access label.
recvTime
date
The date and time the event was received by the Broker.
route
sequence of structs
See The route Envelope Field for more information on this field.
Your application can use the awGet<type>Field functions to obtain the values of an event that it has received. Be sure to use the appropriate function for the envelope field's type.
Note:
When referring to envelope fields, you must add _env. to each of the field names shown in the preceding table.
The following example shows how your Broker client can retrieve the pubSeqn field from a received event by using by using the awGetLongField function and specifying the _env.pubSeqn field name:
. . .
BrokerLong seq_number;
. . .
err = awGetLongField(event, "_env.pubSeqn", &seq_number);
if (err != AW_NO_ERROR) {
printf("Error on get long\n%s\n", awErrorToString(err));
return 0;
}
. . .