Author:halw

Date:2008-10-02T21:44:24.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@68 abb3cda0-5349-4a8f-a601-0c33ac3a8c38

documentation/current/solutions/concurrent-computing/eiffelthread/eiffelthread-tutorial/index.wiki

@@ -1,5 +1,17 @@
 [[Property:title|EiffelThread Tutorial]]
 [[Property:weight|-1]]
 [[Property:uuid|c1965bc3-23cf-25d6-02c1-717b7035d41c]]
-== EiffelThread Library Tutorial==
+Multithreaded applications provide a flexible, exciting way of utilizing the power of modern computer systems. EiffelThread supports a powerful multithreaded model, fast and easy to use.
+
+The EiffelThread library is mapped to the native thread library of your platform such as Windows, POSIX, Solaris and Unix International Threads. 
+
+This document will explain how to use the EiffelThread library. To fully take advantage of this documentation you should know some basics about multithreaded systems 
+
+To enable multithreading in the EiffelStudio environment, you will need to do some changes in your project settings. 
+
+There are special considerations for using "once" features in an Eiffel multithreaded environment.
+
+If you encounter problems, take a look at the FAQ list. 
+
+Users of the EiffelThread library in version 4.5 and older should read "changes between 4.5 and 5.0" to get the info they need to migrate their code to the new implementation of threads in Eiffel. 
 

documentation/current/solutions/concurrent-computing/eiffelthread/eiffelthread-tutorial/thread-library-overview.wiki

@@ -27,7 +27,11 @@ Your thread is represented by a class which inherits from <eiffel>THREAD</eiffel
 
 	end -- class MY_THREAD
 </code>
+
+
 Creating a thread is like creating an Eiffel object:
+
+
 <code>
 	my_thread: MY_THREAD
 		-- MY_THREAD inherits from THREAD and defines
@@ -36,16 +40,31 @@ Creating a thread is like creating an Eiffel object:
 	create my_thread
 </code>
 
+
 {{note|You have created a thread object but have not started the thread itself yet. <br/>
 To run the thread, use the feature <eiffel>launch</eiffel> from <eiffel>THREAD</eiffel>. }}
+
+
 <code>	my_thread.launch</code>
+
+
 On the Eiffel side, the procedure <eiffel>execute</eiffel> will be launched. This procedures deferred in class <eiffel>THREAD</eiffel>, you have to define it in <eiffel>MY_THREAD</eiffel>. 
+
+
 On the C side, a C thread will be created and launched. 
-{{warning| '''Caution''': you may call <eiffel>join_all</eiffel> and the end of the execution of the parent thread if you do not want it to die before its child, otherwise they may prematurely terminate. }}
+
+
+{{caution|You may call <eiffel>join_all</eiffel> and the end of the execution of the parent thread if you do not want it to die before its child, otherwise they may prematurely terminate. }}
+
+
 ==The class MUTEX==
 
 The implementation of the class <eiffel>MUTEX</eiffel> is mapped on the C standard thread library. An instance of class <eiffel>MUTEX</eiffel> can be shared between different thread. 
+
+
 <eiffel>my_mutex.pointer</eiffel> is the pointer to the nested C mutex of <eiffel>my_mutex</eiffel>. 
+
+
 * Declaration of the mutex: 
 <code>	my_mutex: MUTEX</code>
 
@@ -59,7 +78,7 @@ The implementation of the class <eiffel>MUTEX</eiffel> is mapped on the C standa
 <code>	my_mutex.unlock</code>
 
 *  <eiffel>try_lock</eiffel>: if it is not locked yet, lock the mutex and return True, otherwise it returns False. 
-<code>	my_mutex.lock</code>
+<code>	my_mutex.try_lock</code>
 
 * Is my mutex initialized? 
 <code>	my_mutex.is_set</code>
@@ -67,11 +86,15 @@ The implementation of the class <eiffel>MUTEX</eiffel> is mapped on the C standa
 
 {{note|on Windows: The <eiffel>MUTEX</eiffel> objects on Windows are recursive while they are not on Unix. A recursive mutex can be locked twice by the same thread. }}
 
-{{warning| '''Caution''': be sure that a mutex is unlocked when it is disposed. }}
+
+{{caution|Be sure that a mutex is unlocked when it is disposed. }}
+
 
 ==The class SEMAPHORE==
 
 Like <eiffel>MUTEX</eiffel>, the features of this class are mapped on the C thread library. An instance of class <eiffel>SEMAPHORE</eiffel> can be shared between thread. 
+
+
 * Declaration of the semaphore : 
 <code>	my_sem: SEMAPHORE</code>
 
@@ -88,11 +111,13 @@ Creation of semaphore: initialize semaphore with nb_tokens, it requires nb_token
 <code>	my_sem.try_wait</code>
 
 
-{{warning| '''Caution''': be sure that a semaphore does not wait for a token when it is disposed }}
+{{caution|Be sure that a semaphore does not wait for a token when it is disposed }}
 
 ==The class CONDITION_VARIABLE==
 
 This class allows to use condition variables in Eiffel. An instance of class <eiffel>CONDITION_VARIABLE</eiffel> can be shared between threads. 
+
+
 * Declaration of the condition variable 
 <code>	my_cond: CONDITION_VARIABLE</code>
 
@@ -106,7 +131,9 @@ This class allows to use condition variables in Eiffel. An instance of class <ei
 	create my_mutex.make
 </code>
 
-<code> my_mutex </code> must be locked by the calling thread so as <eiffel>wait</eiffel> can be called. <eiffel>wait</eiffel> atomically unlocks <code> my_mutex </code> and waits for the condition variable <code> my_mutex </code> to receive a signal. As soon as it received a signal, <code> my_cond </code> locks <code> my_mutex </code>;
+
+<code>my_mutex </code> must be locked by the calling thread so as <eiffel>wait</eiffel> can be called. <eiffel>wait</eiffel> atomically unlocks <code> my_mutex </code> and waits for the condition variable <code> my_mutex </code> to receive a signal. As soon as it received a signal, ''<code>my_cond </code>'' locks ''<code>my_mutex </code>''
+
 <code>
 	my_mutex.lock
 		-- You must lock `my_mutex' before calling wait.
@@ -125,14 +152,17 @@ This class allows to use condition variables in Eiffel. An instance of class <ei
 * Send a signal to all the threads blocked on the condition variable `my_cond'. 
 <code>	my_cond.broadcast</code>
 
-*  
-{{warning| '''Caution''': be sure that a condition variable is unblocked when it is disposed. }}
+
+{{caution|Be sure that a condition variable is unblocked when it is disposed. }}
 
 
 ==Miscellaneous classes==
 
 class <eiffel>THREAD_ATTRIBUTES</eiffel>: defines the attributes of an Eiffel Thread regarding the thread scheduling policy and priority. 
+
+
 ==Controlling execution: THREAD_CONTROL==
+
 *  <eiffel>yield</eiffel>: the calling thread yields its execution in favor of an other thread of same priority. 
 *  <eiffel>join_all</eiffel>: the calling thread waits for all other threads to finished (all its children). 
 * A parent thread can wait for the termination of a child process through the feature <eiffel>join</eiffel> of class <eiffel>THREAD_CONTROL</eiffel> (inherited by <eiffel>THREAD</eiffel>):
@@ -145,15 +175,3 @@ class <eiffel>THREAD_ATTRIBUTES</eiffel>: defines the attributes of an Eiffel Th
 </code>
 
 
-
-
-
-
-}}
-
-
-
-
-
-
-