Whatever message this page gives is out now! Go check it out!

Gateway interface

Last update:
May 18, 2026
coldfusion.eventgateway.Gateway
Interface for implementing ColdFusion event gateways. A class that implements this interface defines a ColdFusion event gateway type that you can use in ColdFusion applications. The class must implement the following methods:
SignatureDescription
GatewayName([String id[, StringconfigFile]])
The gateway constructor.
String getGatewayID ()
Returns the gateway ID.
GatewayHelper getHelper ()
Returns an instance of the GatewayHelper class for this gateway type. instance, or null if the gateway does not have a GatewayHelper class.
Gets the event gateway status.
String outgoingMessage (coldfusion.eventgateway.CFEvent cfmessage)
Handles a message sent by ColdFusion and processes it to send to a message receiver.
void restart ()
Restarts a running event gateway.
void setCFCListeners (String[] listeners)
Identifies the CFCs that listen for incoming messages from the event gateway.
void setGatewayID (String id)
Sets the gateway ID that uniquely identifies the Gateway instance.
void start ()
Starts the event gateway.
void stop ()
Stops the event gateway.

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page