Qortal/altcoinj
3
0
Fork 0
mirror of https://github.com/Qortal/altcoinj.git synced 2025-02-07 14:54:15 +00:00
Code Issues Projects Releases Wiki Activity

Clarify PeerEventListener JavaDocs a bit

Browse Source
This commit is contained in:
Matt Corallo 2013-07-16 20:01:22 +02:00 committed by Mike Hearn
parent 5ef59b9ae1
commit edd0a0907c
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
core/src/main/java/com/google/bitcoin/core/PeerEventListener.java
View File

@ -44,7 +44,8 @@ public interface PeerEventListener {
public void onChainDownloadStarted(Peer peer, int blocksLeft);
/**
* Called when a peer is connected
* Called when a peer is connected. If this listener is registered to a {@link Peer} instead of a {@link PeerGroup},
* this will never be called.
*
* @param peer
* @param peerCount the total number of connected peers
@ -53,7 +54,8 @@ public interface PeerEventListener {
/**
* Called when a peer is disconnected. Note that this won't be called if the listener is registered on a
* {@link PeerGroup} and the group is in the process of shutting down.
* {@link PeerGroup} and the group is in the process of shutting down. If this listener is registered to a
* {@link Peer} instead of a {@link PeerGroup}, this will never be called.
*
* @param peer
* @param peerCount the total number of connected peers
@ -61,10 +63,13 @@ public interface PeerEventListener {
public void onPeerDisconnected(Peer peer, int peerCount);
/**
* Called when a message is received by a peer, before the message is processed. The returned message is
* <p>Called when a message is received by a peer, before the message is processed. The returned message is
* processed instead. Returning null will cause the message to be ignored by the Peer returning the same message
* object allows you to see the messages received but not change them. The result from one event listeners
* callback is passed as "m" to the next, forming a chain.
* callback is passed as "m" to the next, forming a chain.</p>
*
* <p>Note that this will never be called if registered with any executor other than
* {@link com.google.bitcoin.utils.Threading#SAME_THREAD}</p>
*/
public Message onPreMessageReceived(Peer peer, Message m);