Previous Topic: External Agent Socket API Completion Message PayloadNext Topic: External Agent Completion Data Elements

External Socket Agent API › Socket Agent › External Agent Socket API Messages › External Agent Socket API Completion Message › External Agent Completion Data Header

External Agent Completion Data Header

The External Agent Completion Data Header is at the beginning of the data packet.

Bytes

Field Name

Type

Description

Mandatory?

1 – 4

Completion ID

UINT4

A number, returned on the External Agent Socket API response message that is used to uniquely identify the message.

Yes

5 – 6

Completion Flags

UINT2

Big-endian

Do Commit 0x0001

Big Endian.

Yes

7 – 8

Response Flags

UINT2

Big-endian

No Flags currently.

Big Endian.

Yes

9 – 12

Element Count

UINT4

Big-endian.

Number of Data Elements.

Yes

13 – 16

Reserved1

UINT4

Reserved. Must be zero.

Yes

If FLAGS1_DoCommit is not set, the completion is rolled back.