Adobe COLDFUSION 9 Manual page 1328

DEVELOPING COLDFUSION 9 APPLICATIONS
Using External Resources
Methods
void setCFCMethod method)
String getCFCMethod
setCFCTimeout
void seconds)
String getCFCTimeout
getGatewayID
String
GatewayHelper class
ColdFusion includes a coldfusion.eventgateway.GatewayHelper Java marker interface. You implement this interface
to define a class that provides gateway-specific utility methods to the ColdFusion application or listener CFC. For
example, an instant messaging event gateway could use a helper class to provide buddy list management methods to
the application.
The Gateway class must implement a
need such a class).
ColdFusion applications call the
get an instance of the helper class. The application can then call helper class methods using ColdFusion object dot
notation.
The following code defines the SocketHelper class, the gateway helper for the SocketGateway class. It has an empty
constructor and two public methods: one returns the socket IDs; the other closes a specified socket. These classes let
an application monitor and end session connections.
Description
The method in the listener CFC that ColdFusion calls to process this event. By
default, ColdFusion calls the
consistency, Adobe recommends that any event gateway with a single listener
does not override this default. A gateway, such as the ColdFusion XMPP
gateway, that uses different listener methods for different message types, uses
this method to identify the destination method.
The time-out, in seconds, for the listener CFC to process the event request.
When ColdFusion calls the listener CFC to process the event, and the CFC does
not process the event in the specified time-out period, ColdFusion terminates
the request and logs an error in the application.log file. By default, ColdFusion
uses the Timeout Request value set on the Server Settings page in the
ColdFusion Administrator.
The event gateway instance that processes the event. Returns the gateway ID
that was set in the CFEvent constructor.
method that returns the helper class or null (if the gateway does not
getHelper
CFML function, which calls gateway's the
GetGatewayHelper
Last updated 8/5/2010
onIncomingMessage method. For the sake of
getHelper
1323
method to