pollForEvents()

Polls an application's event store for events that cause changes to business objects.

Syntax

public int pollForEvents();
 

Parameters

None.

Return values

An integer that indicates the outcome status of the polling operation.The following return codes are typically used by the pollForEvents() method.

CxStatusConstants.SUCCEED
The polling action succeeded regardless of whether an event is retrieved.

CxStatusConstants.FAIL
The polling operation failed.

CxStatusConstants.APPRESPONSETIMEOUT
The application is not responding.

Notes

The connector infrastructure calls the pollForEvents() method, at a time interval that you can configure, so that the connector can detect any event in the application that is interesting to a subscriber. The frequency at which the class library calls this method depends on the poll frequency value that is configured by the PollFrequency connector configuration property.

Important:
The pollForEvents() method is an abstract method that you must implement to provide your own polling mechanism.

Note:
If your connector executes in a parallel-process mode, it uses a separate polling slave process to handle polling.

Copyright IBM Corp. 1997, 2003