request.cycledStack.add

(since )



Add a command to cycled request stack

Description


string request.cycledStack.add ( string cmd, [object params], [object options] )

APE JSF allows you to create "cycled stacks" of request.

These methods are very useful for example if your application must send different commands to APE server from several functions (or not) and you want to send them all at once.

With request.cycledStack you don't have to care when the command are sent. They are automatically sent (by default each 350ms). This is verry useful for peridical stuff. Or to reduce/optimze bandwith.

Parameters


cmd
If the argument is a string :
  • Command to send to APE server (eg : 'CONNECT') - ()
If the argument is an array :
  • An array with object containing cmd, params and sessid - ()

params
And object with params of the cmd

options
An object with request options :
  • sessid - (boolean, optional) ; defaults to : true Add sessid to the request.

Examples


Capturate mouse move 
//ape var is a reference to APE instance
 
//Note : this example use the server module mouseMotion available on APE Store
 
// capture mousemove event
document.onmousemove=getMouseCoordinates;
 
//Add to the cycled Stack the position of the mouse, and the time 
function getMouseCoordinates(event) {
    ev = event || window.event;
    ape.request.cycledStack.add('mouseMotion', {"x":ev.x, "y":ev.y});
    captureMouse = false;
}
 
//Intercept mouseMotion raw, and display where the mouse was
ape.onRaw('mouseMotion', function(data) {
    console.log('Mouse position, x : ' + data.x + ' / y : ' + data .y);
});

User notes


# No comment

Post a note


User notes may be edited or deleted, and usually a note is deleted because of the following reasons:
  • Bugs: Instead report a bug
  • Missing documentation: report that as a bug.
  • Support questions: See the community for available options.

In other words, do not ask questions within the user notes.

Note <b>,<u>,<i> HTML tags are allowed in the posts and the note formatting is preserved. URLs will be turned into clickable links, JavaScipt and C code blocks enclosed in the <source="javascript">JS Code</source> and <source="c">C Code</source> tags will be source highlighted automatically.