{"id":392,"date":"2018-05-28T11:46:16","date_gmt":"2018-05-27T23:46:16","guid":{"rendered":"https:\/\/content.ronella.xyz\/apps\/wordpress\/?p=392"},"modified":"2018-06-01T14:58:58","modified_gmt":"2018-06-01T02:58:58","slug":"using-cyclicbarrier-with-java","status":"publish","type":"post","link":"https:\/\/www.ronella.xyz\/?p=392","title":{"rendered":"Using CyclicBarrier with Java"},"content":{"rendered":"

CyclicBarrier was designed to allow threads to wait for each other to a certain barrier and doing it again and again (i.e. the reason why it is called cyclic)<\/em>.<\/p>\n

Creating a CyclicBarrier aware Task<\/strong><\/h5>\n
    \n
  1. Create a task<\/strong> that will accepts and instance of CyclicBarrier<\/strong> like the following snippet (i.e. the complete code<\/a> will be at the bottom).<\/em>\n
    public Teller(CyclicBarrier barrier<\/strong>, String message) {\r\n    _barrier = barrier<\/strong>;\r\n    _message = message;\r\n}<\/pre>\n<\/li>\n
  2. Within the task we must call the await<\/strong> method of the instance of the CyclicBarrier like the following snippet (i.e. the complete code<\/a> will be at the bottom).<\/em> The number of call to this method is the one being tracked by the instance of the CyclicBarrier to compare to the number of parties (i.e. normally the first or only argument of the constructor.)<\/em>\u00a0specified during it's initialization.\n
    @Override\r\npublic String call() throws Exception {\r\n    System.out.println(\"Processing: \" + _message);\r\n    _barrier.await()<\/strong>;\r\n    return _message;\r\n}<\/pre>\n<\/li>\n<\/ol>\n
    Using the CyclicBarrier aware Task<\/h5>\n
      \n
    1. Create an instance of CyclicBarrier<\/strong> class with the expected number of parties<\/strong>\u00a0(i.e. normally this is the first or only argument of the constructor)<\/em> before it unblocks itself for all the threads waiting then back to blocking. Optionally, we can also pass a second argument of type Runnable<\/strong> that will only be invoked when the barrier unblocks like the following snippet (i.e. the complete code<\/a> will be at the bottom)<\/em>.\n
      CyclicBarrier barrier = new CyclicBarrier(2 \/*The number of parties. *\/<\/strong>\r\n, () -> System.out.println(\"Barrier open.\") \/*The logic to call when the barrier unblocks. *\/<\/strong>\r\n);<\/pre>\n<\/li>\n
    2. Submit a number of tasks that corresponds to the multiple of the number of parties<\/strong> (e.g.\u00a0from step 1 it could be multiple of 2) <\/em>from step 1 like the following snippet (i.e. the complete code<\/a> will be at the bottom)<\/em>:\n
      futures.add(executor.submit(new Teller(barrier, \"One\"))<\/strong>);\r\nfutures.add(executor.submit(new Teller(barrier, \"Two\"))<\/strong>);\r\nfutures.add(executor.submit(new Teller(barrier, \"Three\"))<\/strong>);\r\nfutures.add(executor.submit(new Teller(barrier, \"Four\"))<\/strong>);\r\n\r\nfutures.forEach((Future future) -> {\r\n    try {\r\n        System.out.println(future.get()<\/strong>);\r\n    } catch (InterruptedException | ExecutionException e) {\r\n        e.printStackTrace();\r\n    }\r\n});<\/pre>\n<\/li>\n<\/ol>\n
      Observation<\/h5>\n
      Upon running the complete code<\/a>:<\/p>\n