resultwrapper.js

/**
 * This class allow for easy handling of async calls
 */

var ResultWrapper = function(ux, timeout) {
  this.cmdmap = {};
  this.ux = ux;
  this.timeout = timeout;
  this.blockcount = 0;
  this.blocktimer = null;

  /**
   * Handles the results generated by functions in MultiRemoteClient.
   * If there is a mapping between ID and function, it's carried out,
   * otherwise nothing happens.
   *
   * @param id The ID of the command which finished
   * @param success true/false
   * @param data Any resulting data (or null)
   */
  this.handler = function(id, success, data) {
    console.log("Wrap: Queued commands: " + JSON.stringify(this.cmdmap, null, 2));
    if (id in this.cmdmap) {
      state = this.cmdmap[id];
      delete this.cmdmap[id];

      console.log('Wrap: #' + id + ' Result: ' + success + ' (Extra data: ' + JSON.stringify(data, null, 2) + ')');

      if (state.blocking) {
        //console.log(state);
        if (--this.blockcount == 0) {
          clearTimeout(this.blocktimer);
          this.ux.showBusyIndicator(false);
          this.ux.blockUI(false);
        } else if (this.blockcount < 0) {
          console.log("ERROR: Blockcount is " + this.blockcount);
        }
      }
      state.handler(success, data);
    } else {
      console.log("ERROR: No handler for command #" + id);
    }
  }

  /**
   * Takes any MultiRemoteCommand and maps a function to be called
   * once the function returns. This is necessary since a lot of
   * functions are async and will return before they're done.
   * This simplifies the use of these functions.
   *
   * @param funcCommand Must return a multiremoteclient async id
   * @param funcFollowUp The function which should be called when command finishes
   * @param blockUI Wether or not to show the visual indicator when things take too long
   */
  this.wrap = function(funcCommand, funcFollowUp, blockUI) {
    console.log("Wrap: Wrapping function " + funcCommand);
    id = funcCommand();
    console.log("Wrap: #" + id + " \"" + funcCommand + "\"");
    self2 = this;
    this.cmdmap[id] = {handler: funcFollowUp, blocking: blockUI, timerid: 0};
    if (blockUI) {
      this.ux.blockUI(true);
      if (this.blockcount++ == 0) {
        this.blocktimer = setTimeout(function(){_id = id; console.log("Wrap: #" + _id + ' timeout'); if (_id in self2.cmdmap) self2.ux.showBusyIndicator(true); }, this.timeout);
      }
    }
  }
}