Description

Returns the maximum size of the ColdFusion event queue, as set in the ColdFusion Administrator.

Category

Event Gateway Development

Syntax

int getMaxQueueSize()

See also

addEvent, getQueueSize

Returns

The integer maximum number of messages that the gateway services queue can hold.

Usage

If the queue length reaches this value, the addEvent method will not add its message to the processing queue. You can use this method and the getQueueSize method to control the rate of event queuing and to help diagnose any throughput problems in your gateways.

Example

The following example logs the queue size, maximum queue size, and other information if a gatewayService.addEvent method fails to queue a message for delivery to a listener CFC. (It uses an internal method to construct the error message string.)

boolean sent = gatewayService.addEvent(cfmsg);
if (!sent)
{
    logger.error(RB.getString(this, "IMGateway.cantAddToQueue",
        gatewayType, gatewayID, ((path != null) ? path : "default"),
        Integer.ToString(gatewayService.getQueueSize()),
        Integer.ToString(gatewayService.getMaxQueueSize())));
}