User Guide

Sending outgoing messages 19
Sending outgoing messages
Your ColdFusion application sends a message to a Flex application by doing the following
actions:
1. The ColdFusion application sends an outgoing message, in a cfreturn tag in the listener
CFC’s listener method, or by calling the ColdFusion
SendGatewayMessage function.
2. A method provided by the Flex Messaging gateway gets called when you send an outgoing
message.
In outgoing messages sent from CFML, the following structure members are translated to the
Flex message:
In addition, the Flex Messaging event gateway automatically provides values for the following
Flex message fields:
Name Contents
body Body of the message. This is required.
CorrelationID Correlation identifier of the message.
Destination Flex destination of the message. This is required if it is not specified in the
configuration file.
Headers If the message contains any headers, the CFML structure that contains
the header names as keys and values.
LowercaseKeys If the value is set to yes, the structure keys are converted to lowercase
during creation of ActionScript types.
TimeToLive Number of milliseconds during which this message is valid.
Name Contents
MessageID A UUID that identifies the message
Timestamp Time the message is sent
ClientID ID of the Flex Messaging event gateway instance
NOTE
A single instance of the Flex Messaging event gateway can send messages to any
destination that is registered with the ColdFusion Event Gateway Adapter. However, if
the destination is configured in the Flex Messaging gateway configuration file, the
destination in the message is ignored.