External Socket Agent API › Socket Agent › External Agent Socket API Messages › Message Description › Message Flags

Message Flags

These are used when running with the Distributor. Although these flags are used to control the Distributor, we recommend using them even if you are not using the Distributor. This ensures that the Distributor can be added later without change.

FLAGS2_ReturnToSenderPort (0x01)

Return the Response Message on the same port as the Request Message.

Set this flag to route the Response Message only to the original port that received the Request Message (or Completion Message). The Distributor always attempts to send the Response Message to the original port. If this flag is not specified, and the Distributor cannot send the Response Message to the original port, then it sends the Response Message to any open port on the same machine.

FLAGS2_EnablePartialEvent(0x02)

Enable partial events.

Set this flag to enable partial event processing for this request. The Socket Agent requests the External Agent API to create a partial event containing only the XML Metadata.

Note: This flag is allowed, but ignored in the current version.

FLAGS2_MultipartMsgFirst (0x04)

FLAGS2_MultipartMsgIntermediate(0x08)

FLAGS2_MultipartMsgLast(0x0C)

Use these flags when the message data is split over multiple messages. Multipart messages are recommended if the total message size would exceed 90 MB – use multipart messages to send the message in messages of less than 90 MB. These flags can be is used with the Data Completion flag of a Data Element – if the data is incomplete, the message must be incomplete, and vice versa. Multipart messages are allowed for Request and completion messages only.