onCmd
(since )
Intercept a command
Description
string
onCmd
(
string type, string fn )
Execute a function when a command is sent and pass to the function the arguments sent to APE server.
If the sent raw is related to a pipe (e.g : you sent data to a channel) the first arguments will be a pipe object.
Parameters
type
Name of the command (e.g : 'connect', 'send');
fn
Callback function to execute
- args - (object, optional) An object containing all data sent to the server.
- pipe - (object, optional) If the request is made on a pipe (e.g : you sent data to a channel) the second argument will be a pipe object.
Examples
//client var is a reference to APE.Client instance
//start(); method is used to connect to APE.
client.core.start();
//Intercept connect command (connect command is used to initiate connection to APE server)
client.onCmd('connect', function() {
console.log('Connect command sent');
});
//client var is a reference to APE.Client instance
//Intercept send command (send command is used to send data to a pipe)
client.onCmd('send', function(pipe, data) {
console.log('You sent ' + data.msg + ' to pipe with pubid' + pipe.getPubid());
});
//Intercept pipeCreate event (when a new pipe is created)
client.addEvent('pipeCreate', function(type, pipe, options) {
//send a message on the pipe ("complex" way)
pipe.request.send('SEND', 'Hello');
//Sending a message could also be done more easily with this code
pipe.send('Hello again!');
});
User notes
# No comment
Post a note
CollaborAPE to our wiki !
Find the information you need on the APE Official Wiki : Install, Server, JSF, Help...
