Sends a CFEvent instance to ColdFusion for dispatching to a listener CFC.
Event Gateway Development
boolean addEvent(CFEvent msg)
getMaxQueueSize, getMaxQueueSize, "Responding to incoming messages" in the ColdFusion Developer's Guide
Parameter |
Description |
---|---|
msg |
The CFEvent object containing the message to be queued for delivery to the listener CFC. |
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.
The event gateway must use this method to send incoming messages to the application for processing.
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); }