Chapter 46. Host Object Definition

Midgard functions like mgd_get_host and mgd_list_hosts return objects upon success. This section describes the contents of thos objects. Most object parameters map directly to the record fields described above.

The functions listed within the object definition are the object methods that are available for the object. Usage information about those methods can be found in Object Methods.


/* Host Object Prototype */

Class host {

  var $N;      // only with mgd_list_XXX functions.
  var $id;
  var $name;
  var $root;
  var $style;
  var $info;
  var $owner;
  var $port;
  var $online;
  var $prefix;
  var $sitegroup;

  function fetch();             // Only with mgd_list_XXX functions.

  function create();
  function update();
  function delete();

  function setsitegroup();
  function getsitegroup();

  function parameter();
  function listparameters();
  function searchparameters();

  function setscore();

  function settype();

  function createattachment();
  function updateattachment();
  function deleteattachment();
  function getattachment();
  function listattachment();
  function openattachment();
  function serveattachment();
}