Whatever message this page gives is out now! Go check it out!
addEvent
Last update:
May 18, 2026
Description
Sends a CFEvent instance to ColdFusion for dispatching to a listener CFC.
Category
Event Gateway Development
Syntax
boolean addEvent(CFEvent msg) |
See also
getMaxQueueSize , getMaxQueueSize , Responding to incoming messages in Building an event gateway in the Developing ColdFusion Applications
Parameters
| Parameter | Description |
msg | The CFEvent object containing the message to be queued for delivery to the listener CFC. |
Returns
True if the event was added to the gateway services queue for delivery, false, otherwise. Therefore, a true response does not indicate that the message was delivered.
Usage
The event gateway must use this method to send incoming messages to the application for processing.
Example
The following example from the ColdFusion SocketGateway code sends an event to all listener CFCs:
for (int i = 0; i < listeners.length; i++) { String path = listeners[i]; CFEvent event = new CFEvent(gatewayID); Hashtable mydata = new Hashtable(); mydata.put("MESSAGE", theInput); event.setData(mydata); event.setGatewayType("SocketGateway"); event.setOriginatorID(theKey); event.setCfcMethod(cfcEntryPoint); event.setCfcTimeOut(10); if (path != null) event.setCfcPath(path); boolean sent = gatewayService.addEvent(event); if (!sent) log.error("SocketGateway(" + gatewayID + ") Unable to put message on event queue. Message not sent from " + gatewayID + ", thread " + theKey + ".Message was " + theInput); } |
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Share additional feedback to help us improve.
0/255
|
