Improve Poison Pill Javadoc

This commit is contained in:
Ilkka Seppala 2015-10-03 23:53:09 +03:00
parent 4d1aae21f7
commit 98aa28d94e

View File

@ -2,12 +2,12 @@ package com.iluwatar.poison.pill;
/**
* One of the possible approaches to terminate Producer-Consumer pattern is using the Poison Pill idiom.
* If you use Poison Pill as the termination signal then Producer is responsible to notify Consumer that exchange is over
* and reject any further messages. Consumer receiving Poison Pill will stop reading messages from the queue.
* You must also ensure that the Poison Pill will be the last message that will be read from the queue (if you have
* prioritized queue then this can be tricky).
* If you use Poison Pill as the termination signal then Producer is responsible to notify Consumer that
* the exchange is over and reject any further messages. The Consumer receiving Poison Pill will stop
* reading messages from the queue. You must also ensure that the Poison Pill will be the last message
* that will be read from the queue (if you have prioritized queue then this can be tricky).
* <p>
* In simple cases as Poison Pill can be used just null-reference, but holding unique separate shared
* In simple cases the Poison Pill can be just a null-reference, but holding a unique separate shared
* object-marker (with name "Poison" or "Poison Pill") is more clear and self describing.
*
*/