Skip to content

Commit 2643dfa

Browse files
committed
iluwatar#467 data-bus: App: add notes about this implementation of the patter
1 parent c96ebcb commit 2643dfa

File tree

1 file changed

+10
-0
lines changed
  • data-bus/src/main/java/com/iluwatar/databus

1 file changed

+10
-0
lines changed

data-bus/src/main/java/com/iluwatar/databus/App.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,16 @@
4646
* will receive the same data, the order each receives a given piece of data, is an
4747
* implementation detail.</p>
4848
* <p>Members may unsubscribe from the Data-Bus to stop receiving data.</p>
49+
* <p>This example of the pattern implements a Synchronous Data-Bus, meaning that
50+
* when data is published to the Data-Bus, the publish method will not return until
51+
* all members have received the data and returned.</p>
52+
* <p>The {@link DataBus} class is a Singleton.</p>
53+
* <p>Members of the Data-Bus must implement the {@link Member} interface.</p>
54+
* <p>Data to be published via the Data-Bus must implement the {@link DataType} interface.</p>
55+
* <p>The {@code data} package contains example {@link DataType} implementations.</p>
56+
* <p>The {@code members} package contains example {@link Member} implementations.</p>
57+
* <p>The {@link StatusMember} demonstrates using the DataBus to publish a message
58+
* to the Data-Bus when it receives a message.</p>
4959
*
5060
* @author Paul Campbell (pcampbell@kemitix.net)
5161
*/

0 commit comments

Comments
 (0)