org/simgrid/msg/Host.java

   1 /*
   2  * Bindings to the MSG hosts
   3  *
   4  * Copyright 2006,2007,2010 The SimGrid Team
   5  * All right reserved.
   6  *
   7  * This program is free software; you can redistribute
   8  * it and/or modify it under the terms of the license
   9  *(GNU LGPL) which comes with this package.
  10  *
  11  */
  12 package org.simgrid.msg;
  13
  14 /**
  15  * A host object represents a location (any possible place) where a process may run.
  16  * Thus it is represented as a physical resource with computing capabilities, some
  17  * mailboxes to enable running process to communicate with remote ones, and some private
  18  * data that can be only accessed by local process. An instance of this class is always
  19  * binded with the corresponding native host. All the native hosts are automatically created
  20  * during the call of the method Msg.createEnvironment(). This method take as parameter a
  21  * platform file which describes all elements of the platform (host, link, root..).
  22  * You cannot create a host yourself.
  23  *
  24  * The best way to get an host instance is to call the static method
  25  * Host.getByName().
  26  *
  27  * For example to get the instance of the host. If your platform
  28  * file description contains an host named "Jacquelin" :
  29  *
  30  * \verbatim
  31 Host jacquelin;
  32
  33 try {
  34         jacquelin = Host.getByName("Jacquelin");
  35 } catch(HostNotFoundException e) {
  36         System.err.println(e.toString());
  37 }
  38 ...
  39 \endverbatim
  40  *
  41  */
  42 public class Host {
  43
  44         /**
  45          * This attribute represents a bind between a java host object and
  46          * a native host. Even if this attribute is public you must never
  47          * access to it. It is set automatically during the call of the
  48          * static method Host.getByName().
  49          *
  50          * @see                         Host.getByName().
  51          */
  52         public long bind;
  53
  54
  55         /**
  56          * User data.
  57          */
  58         private Object data;
  59     /**
  60      *
  61      */
  62     protected Host() {
  63                 this.bind = 0;
  64                 this.data = null;
  65         };
  66
  67         /**
  68          * This static method gets an host instance associated with a native
  69          * host of your platform. This is the best way to get a java host object.
  70          *
  71          * @param name          The name of the host to get.
  72          *
  73      * @return
  74      * @exception               HostNotFoundException if the name of the host is not valid.
  75          *                                      NativeException if the native version of this method failed.
  76          */
  77         public static Host getByName(String name)
  78         throws HostNotFoundException {
  79                 if (name==null)
  80                         throw new NullPointerException("No host can have a null name");
  81                 return MsgNative.hostGetByName(name);
  82         }
  83
  84         /**
  85          * This static method returns the count of the installed hosts.
  86          *
  87          * @return                      The count of the installed hosts.
  88          *
  89          */
  90         public static int getCount() {
  91                 return MsgNative.hostGetCount();
  92         }
  93
  94         /**
  95          * This static method return an instance to the host of the current process.
  96          *
  97          * @return                      The host on which the current process is executed.
  98          */
  99         public static Host currentHost() {
 100                 return MsgNative.hostSelf();
 101         }
 102
 103         /**
 104          * This static method returns all of the hosts of the installed platform.
 105          *
 106          * @return                      An array containing all the hosts installed.
 107          *
 108          */
 109         public static Host[] all()  {
 110                 return MsgNative.allHosts();
 111         }
 112
 113         /**
 114          * This method returns the name of a host.
 115          *
 116          * @return                      The name of the host.
 117          *
 118          */
 119         public String getName()  {
 120                 return MsgNative.hostGetName(this);
 121         }
 122
 123         /**
 124          * Sets the data of the host.
 125          *
 126      *
 127      * @param data
 128      */
 129         public void setData(Object data) {
 130                 this.data = data;
 131         }
 132         /**
 133          * Gets the data of the host.
 134      *
 135      * @return
 136      */
 137         public Object getData() {
 138                 return this.data;
 139         }
 140
 141         /**
 142          * Checks whether a host has data.
 143      *
 144      * @return
 145      */
 146         public boolean hasData() {
 147                 return null != this.data;
 148         }
 149
 150         /**
 151          * This method returns the number of tasks currently running on a host.
 152          * The external load is not taken in account.
 153          *
 154          * @return                      The number of tasks currently running on a host.
 155          */
 156         public int getLoad() {
 157                 return MsgNative.hostGetLoad(this);
 158         }
 159
 160         /**
 161          * This method returns the speed of the processor of a host,
 162          * regardless of the current load of the machine.
 163          *
 164          * @return                      The speed of the processor of the host in flops.
 165          *
 166          */
 167         public double getSpeed() {
 168                 return MsgNative.hostGetSpeed(this);
 169         }
 170
 171     /** This method tests if a host is avail.
 172      * @return
 173      */
 174         public boolean isAvail() {
 175                 return MsgNative.hostIsAvail(this);
 176         }
 177 }