AjaxPeriodicalUpdater

Overview

File

Class

Tree

Index

Help

PHP2Go Javascript Framework

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class AjaxPeriodicalUpdater

Object
   |
   +--AjaxPeriodicalUpdater

class AjaxPeriodicalUpdater

Defined in ajax.js

Field Summary
`Number`	`frequency` Number of seconds between each request
`Function`	`onBeforeUpdate` Called before each request is performed
`AjaxRequest`	`updater` AjaxUpdater instance used to perform periodical requests
`Object`	`updaterArgs` Updater arguments
`String`	`uri` Request URI

Constructor Summary
`AjaxPeriodicalUpdater (<String> uri, <Object> args)` This class is able to perform a periodic update, needed by any kind of polling.

Method Summary
`<private> void`	`onTimer()` Executes an iteration by calling AjaxUpdater.send
`<private> void`	`onUpdate()` Called when updater response is returned
`void`	`start()` Starts the periodical updater
`void`	`stop()` Stops the periodical updater

Field Detail

frequency

Number frequency

Number of seconds between each request

onBeforeUpdate

Function onBeforeUpdate

Called before each request is performed

updater

AjaxRequest updater

AjaxUpdater instance used to perform periodical requests

updaterArgs

Object updaterArgs

Updater arguments

uri

String uri

Request URI

Constructor Detail

AjaxPeriodicalUpdater

AjaxPeriodicalUpdater(<String> uri, <Object> args)

This class is able to perform a periodic update, needed by any kind of polling. An instance of the AjaxUpdater class is created and executed at regular intervals

Parameters:

uri

args

Method Detail

onTimer

 <private> void onTimer()

Executes an iteration by calling AjaxUpdater.send

onUpdate

 <private> void onUpdate()

Called when updater response is returned

start

void start()

Starts the periodical updater

stop

void stop()

Stops the periodical updater