org/simgrid/msg/Host.java

   1 /*
   2  * Bindings to the MSG hosts
   3  *
   4  * Copyright 2006-2012 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         private long bind;
  53         /**
  54          * Host name
  55          */
  56         private String name;
  57
  58         /**
  59          * User data.
  60          */
  61         private Object data;
  62     /**
  63      *
  64      */
  65     protected Host() {
  66                 this.bind = 0;
  67                 this.data = null;
  68         };
  69
  70         /**
  71          * This static method gets an host instance associated with a native
  72          * host of your platform. This is the best way to get a java host object.
  73          *
  74          * @param name          The name of the host to get.
  75          *
  76      * @return
  77      * @exception               HostNotFoundException if the name of the host is not valid.
  78          *                                      NativeException if the native version of this method failed.
  79          */
  80         public native static Host getByName(String name)
  81         throws HostNotFoundException, NullPointerException;
  82         /**
  83          * This static method returns the count of the installed hosts.
  84          *
  85          * @return                      The count of the installed hosts.
  86          * FIXME: Not implemented.
  87          */
  88         public native static int getCount();
  89
  90         /**
  91          * This static method return an instance to the host of the current process.
  92          *
  93          * @return                      The host on which the current process is executed.
  94          */
  95         public native static Host currentHost();
  96
  97         /**
  98          * This static method returns all of the hosts of the installed platform.
  99          *
 100          * @return                      An array containing all the hosts installed.
 101          *
 102          */
 103         public native static Host[] all();
 104
 105         /**
 106          * This method returns the name of a host.
 107          * @return                      The name of the host.
 108          *
 109          */
 110         public String getName() {
 111                 return name;
 112         }
 113         /**
 114          * Sets the data of the host.
 115      * @param data
 116      */
 117         public void setData(Object data) {
 118                 this.data = data;
 119         }
 120         /**
 121          * Gets the d   ata of the host.
 122      *
 123      * @return
 124      */
 125         public Object getData() {
 126                 return this.data;
 127         }
 128
 129         /**
 130          * Checks whether a host has data.
 131      *
 132      * @return
 133      */
 134         public boolean hasData() {
 135                 return null != this.data;
 136         }
 137
 138         /**
 139          * This method returns the number of tasks currently running on a host.
 140          * The external load is not taken in account.
 141          *
 142          * @return                      The number of tasks currently running on a host.
 143          */
 144         public native int getLoad();
 145
 146         /**
 147          * This method returns the speed of the processor of a host,
 148          * regardless of the current load of the machine.
 149          *
 150          * @return                      The speed of the processor of the host in flops.
 151          *
 152          */
 153         public native double getSpeed();
 154
 155     /** This method tests if a host is avail.
 156      * @return
 157      */
 158         public native boolean isAvail();
 159
 160         /**
 161          * Class initializer, to initialize various JNI stuff
 162          */
 163         public static native void nativeInit();
 164         static {
 165                 nativeInit();
 166         }
 167 }