1 /* Functions related to the java host instances. */
3 /* Copyright (c) 2007, 2009, 2010. 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. */
16 * This function returns a new java host instance.
18 * @param env The environment of the current thread
20 * @return A new java host object.
22 * @exception If the class Host is not found the function throws
23 * the ClassNotFoundException. If the constructor of
24 * this class is not found the function throws the exception
25 * NotSuchMethodException.
27 jobject jhost_new_instance(JNIEnv * env);
30 * This function returns a global reference to the java host instance
31 * specified by the parameter jhost.
33 * @param jhost The original java host instance.
34 * @param env The environment of the current thread
36 * @return The global reference to the original java host
39 jobject jhost_ref(JNIEnv * env, jobject jhost);
41 * This function delete a global reference to a java host instance.
43 * @param The global refernce to delete.
44 * @param env The environment of the current thread
46 void jhost_unref(JNIEnv * env, jobject jhost);
49 * This function associated a native host to a java host instance.
51 * @param jhost The java host instance.
52 * @param host The native host to bind.
53 * @param env The environment of the current thread
55 * @exception If the class Host is not found the function throws
56 * the ClassNotFoundException. If the field bind of
57 * this class is not found the function throws the exception
58 * NotSuchFieldException.
60 void jhost_bind(jobject jhost, m_host_t host, JNIEnv * env);
63 * This function returns a native host from a java host instance.
65 * @param jhost The java host object from which get the native host.
66 * @param env The environment of the current thread
68 * @return The function returns the native host associated to the
71 * @exception If the class Host is not found the function throws
72 * the ClassNotFoundException. If the field bind of
73 * this class is not found the function throws the exception
74 * NotSuchFieldException.
76 m_host_t jhost_get_native(JNIEnv * env, jobject jhost);
79 * This function returns the name of a MSG host.
81 * @param jhost A java host object.
82 * @param env The environment of the current thread
84 * @return The name of the host.
86 const char *jhost_get_name(jobject jhost, JNIEnv * env);
90 * This function sets the name of a MSG host.
92 * @param host The host concerned by the operation.
93 * @param jname The new name of the host.
94 * @param env The environment of the current thread
96 void jhost_set_name(jobject jhost, jstring jname, JNIEnv * env);
99 * This function tests if a java host instance is valid.
100 * A java host object is valid if it is bind to a native host.
102 * @param jhost The host to test the validity.
103 * @param env The environment of the current thread
105 * @return If the java host is valid the function returns true.
106 * Otherwise the function returns false.
108 jboolean jhost_is_valid(jobject jhost, JNIEnv * env);
110 #endif /*!MSG_JHOST_H */