Event Gateways section

The Event Gateways section of the Administrator lets you configure event gateway settings, gateway types, and gateway instances.

    Event gateways overview

    ColdFusion event gateways are ColdFusion elements that let ColdFusion react to or generate external events or messages in an asynchronous manner. Event gateways let a ColdFusion application handle information that does not come through an HTTP request. For example, you can use event gateways to handle instant messages, short messages from mobile devices, or messages sent to a TCP/IP port.ColdFusion includes several event gateways, including an SMS (Short Message Service) gateway for sending short, often text, messages to and from wireless devices, such as mobile phones or pagers and a gateway for the XMPP (Extensible Messaging and Presence Protocol) instant messaging protocol.

    Event Gateways Settings page

    The Event Gateways Settings page lets you configure settings for all event gateways, and start or stop the Short Message Service (SMS) test server. The following table describes the settings:

    Option

    Description

    Enable ColdFusion Event Gateway Services

    Specifies whether the service is enabled. Changing this setting restarts the service.

    Event Gateway Processing Threads

    Specifies the maximum number of threads used to execute ColdFusion functions when an event arrives. A higher number uses more resources, but increases event throughput.

    Maximum Number Of Events To Queue

    Specifies the maximum number of events allowed on the event queue. If the queue length exceeds this value, gateway events are not be added to the processing queue.

    Start/Stop SMS Test Server

    Starts and stops the short message service (SMS) test server.

    Gateway Types page

    The Gateways Types pages let you configure the types of gateways available on your system. After you configure a type, you can create any number of gateway instances of that type.

    Option

    Description

    Type Name

    Specifies a name for the event gateway type (for example, SMS for the SMS event gateway).

    Description

    Specifies a description for the gateway type.

    Java Class

    Specifies the fully qualified name of the gateway class full Java class name (for example, coldfusion.eventgateway.sms.SMSGateway for the SMS event gateway).

    Startup Timeout [n] Seconds

    Specifies a startup timeout, in seconds.

    Stop on Startup Timeout

    If enabled, ColdFusion stops the gateway class if it times out on startup. If disabled, ColdFusion logs a warning message when the timeout value is exceeded.

    The following table describes the event gateway types that ColdFusion includes:

    Gateway type

    Description

    CFML

    Triggers asynchronous events from ColdFusion.

    DataManagement

    Lets a ColdFusion application notify a Flex destination about changes in the data that the destination manages.

    DataServicesMessaging

    Sends messages to and receive messages from Flex applications.

    FMS Gateway

    Modifies data through the ColdFusion application or the Flash client, and reflects the change in the Flash Media Server shared object.

    SMS

    Used to send and receive SMS messages.

    SAMETIME

    Used to send and receive instant messages through Lotus SameTime.

    XMPP

    Used to send and receive instant messages through the Extensible Messaging and Presence Protocol (XMPP).

    Samples

    Sample gateway types, including the following:

    • DirectoryWatcher Watches a directory for file changes.

    • JMS Acts as a Java Messaging Service consumer or producer.

    • Socket Listens on a TCP/IP port.

    Gateway Instances page

    The Gateway Instances page lets you configure ColdFusion event gateway instances to direct events from various sources to ColdFusion components (CFCs) that you have written. The following table describes the settings:

    Option

    Description

    Gateway ID

    A name for the event gateway instance. You use this value in the ColdFusion GetGatewayHelper and SendGatewayMessage functions.

    Gateway Type

    The event gateway type.

    CFC Path

    The absolute path to the listener CFC that handles incoming messages.

    Configuration File

    (Optional) Configuration file, if necessary for the event gateway instance.

    Startup Mode

    The event gateway startup status, as follows:

    • Automatic Start the event gateway when ColdFusion starts.

    • Manual Do not start the event gateway with ColdFusion, but allow starting it from the Gateway Instances page.

    • Disabled Do not allow the event gateway to start.