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 native static Host getByName(String name)
  78         throws HostNotFoundException, NullPointerException;
  79         /**
  80          * This static method returns the count of the installed hosts.
  81          *
  82          * @return                      The count of the installed hosts.
  83          * FIXME: Not implemented.
  84          */
  85         public native static int getCount();
  86
  87         /**
  88          * This static method return an instance to the host of the current process.
  89          *
  90          * @return                      The host on which the current process is executed.
  91          */
  92         public native static Host currentHost();
  93
  94         /**
  95          * This static method returns all of the hosts of the installed platform.
  96          *
  97          * @return                      An array containing all the hosts installed.
  98          *
  99          */
 100         public native static Host[] all();
 101
 102         /**
 103          * This method returns the name of a host.
 104          * FIXME: Cache it.
 105          * @return                      The name of the host.
 106          *
 107          */
 108         public native String getName();
 109         /**
 110          * Sets the data of the host.
 111      * @param data
 112      */
 113         public void setData(Object data) {
 114                 this.data = data;
 115         }
 116         /**
 117          * Gets the d   ata of the host.
 118      *
 119      * @return
 120      */
 121         public Object getData() {
 122                 return this.data;
 123         }
 124
 125         /**
 126          * Checks whether a host has data.
 127      *
 128      * @return
 129      */
 130         public boolean hasData() {
 131                 return null != this.data;
 132         }
 133
 134         /**
 135          * This method returns the number of tasks currently running on a host.
 136          * The external load is not taken in account.
 137          *
 138          * @return                      The number of tasks currently running on a host.
 139          */
 140         public native int getLoad();
 141
 142         /**
 143          * This method returns the speed of the processor of a host,
 144          * regardless of the current load of the machine.
 145          *
 146          * @return                      The speed of the processor of the host in flops.
 147          *
 148          */
 149         public native double getSpeed();
 150
 151     /** This method tests if a host is avail.
 152      * @return
 153      */
 154         public native boolean isAvail();
 155
 156
 157 }