Description

starts a gateway running.

Category

Event Gateway Development

Syntax

public void start()

See also

restart, stop, "The start method" in the ColdFusion Developer's Guide

Usage

Start a gateway by performing any required initialization. This method starts any listener thread or threads that monitor the gateway's event source. The ColdFusion Administrator calls this function when it starts a gateway instance.

This method should update the status information that is returned by the getStatus method to indicate when the gateway is starting and when the gateway is running.

The ColdFusion Administrator Gateway Types page lets you specify a time-out for the gateway startup, and whether to kill the gateway on startup time-out. If you enable the kill option and the start method does not return in the time-out period, ColdFusion kills the thread that called this function.

Example

The following example is the ColdFusion SocketGateway class restart method:

public void start()
    {
        status = STARTING;
        listening=true;
        // Start up event generator thread
        Runnable r = new Runnable()
        {
            public void run()
            {
                socketServer();
            }
        };
        Thread t = new Thread(r);
        t.start();
        status = RUNNING;
    }