Groovy - Multithreading

---

---

Groovy is a multi-threaded programming language which means we can develop multi-threaded program using Groovy. A multi-threaded program contains two or more parts that can run concurrently and each part can handle a different task at the same time making optimal use of the available resources specially when your computer has multiple CPUs.

By definition, multitasking is when multiple processes share common processing resources such as a CPU. Multi-threading extends the idea of multitasking into applications where you can subdivide specific operations within a single application into individual threads. Each of the threads can run in parallel. The OS divides processing time not only among different applications, but also among each thread within an application.

Groovy Multithreading

Multi-threading enables you to write in a way where multiple activities can proceed concurrently in the same program. To achieve the multithreading (or, write multithreaded code), you need java.lang.Thread class.

Life Cycle of a Thread in Groovy Multithreading

A thread goes through various stages in its life cycle. For example, a thread is born, started, runs, and then dies. The following diagram shows the complete life cycle of a thread.

Following are the stages of the life cycle −

• New − A new thread begins its life cycle in the new state. It remains in this state until the program starts the thread. It is also referred to as a born thread.

• Runnable − After a newly born thread is started, the thread becomes runnable. A thread in this state is considered to be executing its task.

• Waiting − Sometimes, a thread transitions to the waiting state while the thread waits for another thread to perform a task. A thread transitions back to the runnable state only when another thread signals the waiting thread to continue executing.

• Timed Waiting − A runnable thread can enter the timed waiting state for a specified interval of time. A thread in this state transitions back to the runnable state when that time interval expires or when the event it is waiting for occurs.

• Terminated (Dead) − A runnable thread enters the terminated state when it completes its task or otherwise terminates.

Thread Priorities

Every Groovy thread has a priority that helps the operating system determine the order in which threads are scheduled.

Groovy thread priorities are in the range between MIN_PRIORITY (a constant of 1) and MAX_PRIORITY (a constant of 10). By default, every thread is given priority NORM_PRIORITY (a constant of 5).

Threads with higher priority are more important to a program and should be allocated processor time before lower-priority threads. However, thread priorities cannot guarantee the order in which threads execute and are very much platform dependent.

Create a Thread by Implementing a Runnable Interface

If your class is intended to be executed as a thread then you can achieve this by implementing a Runnable interface. You will need to follow three basic steps −

Step 1: Implement run() Method

As a first step, you need to implement a run() method provided by a Runnable interface. This method provides an entry point for the thread and you will put your complete business logic inside this method. Following is a simple syntax of the run() method −

public void run( )

Step 2: Instantiate a Thread Object

As a second step, you will instantiate a Thread object using the following constructor −

Thread(Runnable threadObj, String threadName);

Where, threadObj is an instance of a class that implements the Runnable interface and threadName is the name given to the new thread.

Step 3: Call Thread using start() Method

Once a Thread object is created, you can start it by calling start() method, which executes a call to run( ) method. Following is a simple syntax of start() method −

public void start();

Example - Create Thread by Implementing Runnable Interface

Here is an example that creates a new thread and starts running it −

Example.groovy

class Example {
   static void main(String[] args) {
      Runnable r1 = new RunnableDemo( "Thread-1");
      r1.start();
      
      Runnable r2 = new RunnableDemo( "Thread-2");
      r2.start();
   }   
}
class RunnableDemo implements Runnable {
   private Thread t;
   private String threadName;
   
   RunnableDemo( String name) {
      threadName = name;
      println("Creating " +  threadName );
   }
   
   void run() {
      println("Running " +  threadName );
      try {
         for(int i = 4; i > 0; i--) {
            println("Thread: " + threadName + ", " + i);
            // Let the thread sleep for a while.
            Thread.sleep(50);
         }
      } catch (InterruptedException e) {
         println("Thread " +  threadName + " interrupted.");
      }
      println("Thread " +  threadName + " exiting.");
   }
   
   void start () {
      println("Starting " +  threadName );
      if (t == null) {
         t = new Thread (this, threadName);
         t.start ();
      }
   }
}

Output

This will produce the following result−

Creating Thread-1
Starting Thread-1
Creating Thread-2
Starting Thread-2
Running Thread-1
Thread: Thread-1, 4
Running Thread-2
Thread: Thread-2, 4
Thread: Thread-1, 3
Thread: Thread-2, 3
Thread: Thread-1, 2
Thread: Thread-2, 2
Thread: Thread-1, 1
Thread: Thread-2, 1
Thread Thread-1 exiting.
Thread Thread-2 exiting.

Create a Thread by Extending a Thread Class

The second way to create a thread is to create a new class that extends Thread class using the following two simple steps. This approach provides more flexibility in handling multiple threads created using available methods in Thread class.

Step 1: Override run() Method

You will need to override run( ) method available in Thread class. This method provides an entry point for the thread and you will put your complete business logic inside this method. Following is a simple syntax of run() method −

public void run( )

Step 2: Call Thread using start() Method

Once Thread object is created, you can start it by calling start() method, which executes a call to run( ) method. Following is a simple syntax of start() method −

public void start( );

Example - Create Thread by Extending Thread Class

Here is the preceding program rewritten to extend the Thread −

Example.groovy

class Example {
   static void main(String[] args) {
      ThreadDemo t1 = new ThreadDemo( "Thread-1");
      t1.start();
      
      ThreadDemo t2 = new ThreadDemo( "Thread-2");
      t2.start();
   }   
}
class ThreadDemo extends Thread {
   private Thread t;
   private String threadName;
   
   ThreadDemo( String name) {
      threadName = name;
      println("Creating " +  threadName );
   }
   
   void run() {
      println("Running " +  threadName );
      try {
         for(int i = 4; i > 0; i--) {
            println("Thread: " + threadName + ", " + i);
            // Let the thread sleep for a while.
            Thread.sleep(50);
         }
      } catch (InterruptedException e) {
         println("Thread " +  threadName + " interrupted.");
      }
      println("Thread " +  threadName + " exiting.");
   }
   
   void start () {
      println("Starting " +  threadName );
      if (t == null) {
         t = new Thread (this, threadName);
         t.start ();
      }
   }
}

Output

This will produce the following result−

Creating Thread-1
Starting Thread-1
Creating Thread-2
Starting Thread-2
Running Thread-1
Thread: Thread-1, 4
Running Thread-2
Thread: Thread-2, 4
Thread: Thread-1, 3
Thread: Thread-2, 3
Thread: Thread-1, 2
Thread: Thread-2, 2
Thread: Thread-1, 1
Thread: Thread-2, 1
Thread Thread-1 exiting.
Thread Thread-2 exiting.

Thread Methods

Following is the list of important methods available in the Thread class.

The previous methods are invoked on a particular Thread object. The following methods in the Thread class are static. Invoking one of the static methods performs the operation on the currently running thread.

Example - Using Thread methods

The following Example program demonstrates some of these methods of the Thread class. Consider a class DisplayMessage which implements Runnable −

// Create a thread to implement Runnable
class DisplayMessage implements Runnable {
   private String message;
   
   DisplayMessage(String message) {
      this.message = message;
   }
   
   void run() {
      while(true) {
         println(message);
      }
   }
}

Following is another class which extends the Thread class −

// Create a thread to extentd Thread
class GuessANumber extends Thread {
   private int number;
   GuessANumber(int number) {
      this.number = number;
   }
   
   void run() {
      int counter = 0;
      int guess = (int) (Math.random() * 100 + 1);
      while(guess != number) {
         guess = (int) (Math.random() * 100 + 1);
         println(this.getName() + " guesses " + guess);
         counter++;
      } 
      println("** Correct!" + this.getName() + "in" + counter + "guesses.**");
   }
}

Following is the main program, which makes use of the above-defined classes −

class Example {
   static void main(String [] args) {
      Runnable hello = new DisplayMessage("Hello");
      Thread thread1 = new Thread(hello);
      thread1.setDaemon(true);
      thread1.setName("hello");
      println("Starting hello thread...");
      thread1.start();
      
      Runnable bye = new DisplayMessage("Goodbye");
      Thread thread2 = new Thread(bye);
      thread2.setPriority(Thread.MIN_PRIORITY);
      thread2.setDaemon(true);
      println("Starting goodbye thread...");
      thread2.start();

      println("Starting thread3...");
      Thread thread3 = new GuessANumber(27);
      thread3.start();
      try {
         thread3.join();
      } catch (InterruptedException e) {
         println("Thread interrupted.");
      }
      println("Starting thread4...");
      Thread thread4 = new GuessANumber(75);
      
      thread4.start();
      println("main() is ending...");
   }
}
class DisplayMessage implements Runnable {
   private String message;
   
   DisplayMessage(String message) {
      this.message = message;
   }
   
   void run() {
      while(true) {
         println(message);
      }
   }
}
class GuessANumber extends Thread {
   private int number;
   GuessANumber(int number) {
      this.number = number;
   }
   
   void run() {
      int counter = 0;
      int guess = (int) (Math.random() * 100 + 1);
      while (guess != number){
         guess = (int) (Math.random() * 100 + 1);
         println(this.getName() + " guesses " + guess);
         counter++;
      }
      println("** Correct!" + this.getName() + "in" + counter + "guesses.**");
   }
}

Output

This will produce the following result−

Starting hello thread...
Starting goodbye thread...
Hello
Hello
Hello
Hello
Hello
Hello
Goodbye
Goodbye
Goodbye
Goodbye
Goodbye
.......

Major Groovy Multithreading Concepts

While doing Multithreading programming in Groovy, you would need to have the following concepts very handy −

• What is thread synchronization?

• Handling interthread communication

• Handling thread deadlock

• Major thread operations