Adobe ColdFusion 8

setGatewayID

Description

Sets the gateway ID that uniquely identifies the Gateway instance.

Category

Event Gateway Development

Syntax

public void setGatewayID(String id)

See also

Constructor, getGatewayID, "Providing Gateway class service and information routines" in the ColdFusion Developer's Guide

Parameters

Parameter

Description

id

The identifier for this gateway instance.

Usage

This method sets a string value that is returned by the getGatewayID method. ColdFusion calls this method to set the gateway ID with the value specified in the gateway instance configuration in the ColdFusion Administrator before it starts the event gateway, even if the Gateway constructor also sets the ID.

Example

The following example is the ColdFusion SocketGateway class setGatewayID method:

public void setGatewayID(String id)
    {
        gatewayID = id;
    }