This event fires after the engine receives a packet from the server. The packet received is passed as the single parameter.
another way to deal with this event is to pass a "handler" function to sendPacket(). Both are legitimate uses. You are free to use either method or both.

Example:

  domapi.rpc.onreceive = function(packet){
  alert("Received packet " + packet.guid);
};

Parameters:

This event fires when a packet is dispatched to the server. You can analyze the packet (which is passed as the only parameter) to determine what it contained. Each packet created has a unique guid, which can be used to track it's progress through the engine via the onsend() and onreceive() events.

Example:

  domapi.rpc.onreceive = function(packet){
  if(packet.guid == "GUID_3")alert("Order data sent to server for processing"); 
};

Parameters:

Fires whenever a packet times out. Passes the packet in question to the handler if defined.

Example:

  domapi.rpc.ontimeout = myCustomTimeoutFunction;

Parameters:

This method is called by the server code. You do not call it from your client code.
If you would like to interact with the receivePacket() method, see the onreceive() event.

Parameters:

The "arg" parameter fed to this method is an inline Object. See below for accepted parameters.
Any parameters not listed here that you add may also be attached to any returned Object.

This places the passed packet in the send queue. If no other packets were in the queue, it is dispatched immediately, otherwise packets are dispatched on a first-come-first-serve basis.
sendPacket() also accepts an optional handler function. This handler will be fired when the sent packet returns from the server. The incoming packet is also passed to this handler. Handlers are matched to packets by the packet id so it is very important that your server code pass the sent id back in the response packet.

Example:

  var myPacket = new RPCPacket("newCust.cgi/add","Saving new customer");
myPacket.loadFromForm(document.custForm);
myPacket.data.add("cust_added",new Date());
domapi.rpc.sendPacket({
  packet    : myPacket, 
  onreceive : custAdded  //custAdded called on success
});

Available "arg" Parameters:

Manually changes the cursor. This method is called automatically if manageCursor is true.

Parameters:

You can change this to suit your needs.

Example:

  domapi.rpc.charset = "UTF-8";

When true, the engine will display urls it is about to use. It also will not hide the normally hidden IFRAME.
Note that this IFRAME is not created until after the first call to sendPacket().

If an error is raised, this contains the last message. Useful for debugging.

useful for debugging, contains last request sent

Permits the engine to change the cursor to the "busy" icon when packets are in motion.

The default timeout for sent packets. Defaults to 30 seconds. You can override this for individual packets when sending them.