Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #706 from csmith/master
Add an interface for the event bus.
- Loading branch information
Showing
3 changed files
with
88 additions
and
5 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
/* | ||
* Copyright (c) 2006-2016 DMDirc Developers | ||
* | ||
* Permission is hereby granted, free of charge, to any person obtaining a copy | ||
* of this software and associated documentation files (the "Software"), to deal | ||
* in the Software without restriction, including without limitation the rights | ||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
* copies of the Software, and to permit persons to whom the Software is | ||
* furnished to do so, subject to the following conditions: | ||
* | ||
* The above copyright notice and this permission notice shall be included in | ||
* all copies or substantial portions of the Software. | ||
* | ||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
* SOFTWARE. | ||
*/ | ||
|
||
package com.dmdirc.interfaces; | ||
|
||
import com.dmdirc.events.DMDircEvent; | ||
|
||
/** | ||
* An event bus offers facilities for publishing events to decoupled handlers. | ||
*/ | ||
public interface EventBus { | ||
|
||
/** | ||
* Subscribe all handlers of the given listener. Any listener is only subscribed once; subsequent subscriptions of | ||
* an already subscribed listener will be silently ignored. | ||
*/ | ||
void subscribe(Object listener); | ||
|
||
/** | ||
* Immediately remove all registered handlers (if any) of the given listener. When this call returns all handlers | ||
* have effectively been removed and will not receive any messages. | ||
* | ||
* <p>A call to this method passing any object that is not subscribed will not have any effect and is silently | ||
* ignored. | ||
*/ | ||
void unsubscribe(Object listener); | ||
|
||
/** | ||
* Synchronously publish a message to all registered listeners. This includes listeners defined for super types of | ||
* the given message type, provided they are not configured to reject valid subtype. The call returns when all | ||
* matching handlers of all registered listeners have been notified (invoked) of the message. | ||
*/ | ||
void publish(DMDircEvent message); | ||
|
||
/** | ||
* Asynchronously publish a message to all registered listeners. This includes listeners defined for super types of | ||
* the given message type, provided they are not configured to reject valid subtype. The call returns immediately. | ||
*/ | ||
void publishAsync(DMDircEvent message); | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters