host-api.js

/**
 * Interface for creating a host.
 *
 * @param {Object} [options] optional options for host.
 */
function Host(options) {
  this.metadata = {
    host: 'firefox',
    wifi: false,
    otherStuffAboutThisHost: true
  }
}

var Host.prototype = {
  /**
   *  @type Object where metadata is stored.
   * /
  metadata: null,
  
  /**
   * Hard (from initial state) start of host.
   *
   * @param {Function} callback to signal completion [Error err, Number port].
   */
  start: function(callback) {
  },

  /**
   * Restart the host process. Typically this indicates a "soft" restart
   * if available which would be faster then start/stop.
   *
   * @param {Function} callback to signal completion [Error, Number port].
   */
  restart: function() {
  },

  /**
   * Stop the host from running.
   *
   * @param {Function} callback to signal completion [Error].
   */
  stop: function() {
  }
};


module.exports = Host;