AmiSubscription::setCallbackInterval()

Method

Declaration

AmiStatus setCallbackInterval(int inInterval);

Purpose

Indicates that for this subscription the associated AmiMethod::onInvoke callback should be invoked automatically at the specified interval.

Remarks

This provides an asynchronous event to trigger what would normally be synchronous methods so that they can behave as asynchronous methods. A typical scenario is a method that must calculate (polled) data over a precise time interval and return the calculated result based on that interval. In this case the method returns data not based on a synchronous call but on a specified time interval.

Parameters

 

Parameter

Description

inInterval

Interval in seconds. Zero disables the interval.