1 /* Bindings to the MSG hosts */
3 /* Copyright (c) 2006-2014. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
9 package org.simgrid.msg;
11 import org.simgrid.msg.Storage;
14 * A host object represents a location (any possible place) where a process may run.
15 * Thus it is represented as a physical resource with computing capabilities, some
16 * mailboxes to enable running process to communicate with remote ones, and some private
17 * data that can be only accessed by local process. An instance of this class is always
18 * bound with the corresponding native host. All the native hosts are automatically created
19 * during the call of the method Msg.createEnvironment(). This method take as parameter a
20 * platform file which describes all elements of the platform (host, link, root..).
21 * You cannot create a host yourself.
23 * The best way to get an host instance is to call the static method
26 * For example to get the instance of the host. If your platform
27 * file description contains an host named "Jacquelin" :
33 jacquelin = Host.getByName("Jacquelin");
34 } catch(HostNotFoundException e) {
35 System.err.println(e.toString());
44 * This attribute represents a bind between a java host object and
45 * a native host. Even if this attribute is public you must never
46 * access to it. It is set automatically during the call of the
47 * static method Host.getByName().
49 * @see Host.getByName().
52 protected String name;
62 public String toString (){
67 * This static method gets an host instance associated with a native
68 * host of your platform. This is the best way to get a java host object.
70 * @param name The name of the host to get.
72 * @return The host object with the given name.
73 * @exception HostNotFoundException if the name of the host is not valid.
74 * NativeException if the native version of this method failed.
76 public static native Host getByName(String name) throws HostNotFoundException, NullPointerException;
77 /** Counts the installed hosts. */
78 public static native int getCount();
80 /** Returns the host of the current process. */
81 public static native Host currentHost();
83 /** Returns all hosts of the installed platform. */
84 public static native Host[] all();
87 * This static method sets a mailbox to receive in asynchronous mode.
89 * All messages sent to this mailbox will be transferred to
90 * the receiver without waiting for the receive call.
91 * The receive call will still be necessary to use the received data.
92 * If there is a need to receive some messages asynchronously, and some not,
93 * two different mailboxes should be used.
95 * @param mailboxName The name of the mailbox
97 public static native void setAsyncMailbox(String mailboxName);
99 public String getName() {
103 public void setData(Object data) {
107 public Object getData() {
110 /** Returns true if the host has an associated data object. */
111 public boolean hasData() {
112 return null != this.data;
115 /** Starts the host if it is off */
116 public native void on();
117 /** Stops the host if it is on */
118 public native void off();
121 * This method returns the speed of the processor of a host (in flops),
122 * regardless of the current load of the machine.
124 public native double getSpeed();
125 public native double getCoreNumber();
127 public native String getProperty(String name);
128 public native void setProperty(String name, String value);
129 /** Tests if an host is up and running. */
130 public native boolean isOn();
132 /** Returns the list of mount point names on an host */
133 public native Storage[] getMountedStorage();
134 /** This methods returns the list of storages (names) attached to an host */
135 public native String[] getAttachedStorage();
137 /** Returns the amount of Joules consumed by that host so far */
138 public native double getConsumedEnergy();
140 /** Class initializer, to initialize various JNI stuff */
141 public static native void nativeInit();