Yahoo! UI Library

datasource  3.1.0

Yahoo! UI Library > datasource > Pollable
Search:
 
Filters

Class Pollable - extends DataSource.Local

Adds polling to the DataSource Utility.

Properties

_intervals - private object

Hash of polling interval IDs that have been enabled, stored here to be able to clear all intervals.

Properties inherited from Attribute:

Properties inherited from Base:

Properties inherited from DataSource.Local:

Methods

clearAllIntervals

void clearAllIntervals ( )
Clears all intervals.

clearInterval

void clearInterval ( id )
Disables polling mechanism associated with the given interval ID.
Parameters:
id <Number> Interval ID.

setInterval

Number setInterval ( msec , request )
Sets up a polling mechanism to send requests at set intervals and forward responses to given callback.
Parameters:
msec <Number> Length of interval in milliseconds.
request <Object> An object literal with the following properties:
request
The request to send to the live data source, if any.
callback
An object literal with the following properties:
success
The function to call when the data is ready.
failure
The function to call upon a response failure condition.
argument
Arbitrary data payload that will be passed back to the success and failure handlers.
cfg
Configuration object, if any.
Returns: Number
Interval ID.

Configuration attributes inherited from Base:

Configuration attributes inherited from DataSource.Local:


Copyright © 2010 Yahoo! Inc. All rights reserved.