org.bitcoinj.jni

Class NativePeerEventListener

java.lang.Object

org.bitcoinj.jni.NativePeerEventListener

All Implemented Interfaces:

BlocksDownloadedEventListener, ChainDownloadStartedEventListener, GetDataEventListener, OnTransactionBroadcastListener, PeerConnectedEventListener, PeerConnectionEventListener, PeerDataEventListener, PeerDisconnectedEventListener, PeerDiscoveredEventListener, PreMessageReceivedEventListener

public class NativePeerEventListener
extends Object
implements PeerConnectionEventListener, PeerDataEventListener, OnTransactionBroadcastListener

An event listener that relays events to a native C++ object. A pointer to that object is stored in this class using JNI on the native side, thus several instances of this can point to different actual native implementations.

Field Summary

Fields

Modifier and Type	Field and Description
long	ptr

Constructor Summary

Constructors

Constructor and Description
NativePeerEventListener()

Method Summary

Modifier and Type	Method and Description
List<Message>	getData(Peer peer, GetDataMessage m) Called when a peer receives a getdata message, usually in response to an "inv" being broadcast.
void	onBlocksDownloaded(Peer peer, Block block, FilteredBlock filteredBlock, int blocksLeft) Called on a Peer thread when a block is received.
void	onChainDownloadStarted(Peer peer, int blocksLeft) Called when a download is started with the initial number of blocks to be downloaded.
void	onPeerConnected(Peer peer, int peerCount) Called when a peer is connected.
void	onPeerDisconnected(Peer peer, int peerCount) Called when a peer is disconnected.
void	onPeersDiscovered(Set<PeerAddress> peerAddresses) Called when peers are discovered, this happens at startup of PeerGroup or if we run out of suitable Peers to connect to.
Message	onPreMessageReceived(Peer peer, Message m) Called when a message is received by a peer, before the message is processed.
void	onTransaction(Peer peer, Transaction t) Called when a new transaction is broadcast over the network.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ptr

public long ptr

Constructor Detail

NativePeerEventListener

public NativePeerEventListener()

Method Detail

onPeersDiscovered

public void onPeersDiscovered(Set<PeerAddress> peerAddresses)

Description copied from interface: PeerDiscoveredEventListener

Called when peers are discovered, this happens at startup of PeerGroup or if we run out of suitable Peers to connect to.

Specified by:

onPeersDiscovered in interface PeerDiscoveredEventListener

Parameters:

peerAddresses - the set of discovered PeerAddresses

onBlocksDownloaded

public void onBlocksDownloaded(Peer peer,
                               Block block,
                               @Nullable
                               FilteredBlock filteredBlock,
                               int blocksLeft)

Description copied from interface: BlocksDownloadedEventListener

Called on a Peer thread when a block is received.

The block may be a Block object that contains transactions, a Block object that is only a header when fast catchup is being used. If set, filteredBlock can be used to retrieve the list of associated transactions.

Specified by:

onBlocksDownloaded in interface BlocksDownloadedEventListener

Parameters:

peer - the peer receiving the block

block - the downloaded block

filteredBlock - if non-null, the object that wraps the block header passed as the block param.

blocksLeft - the number of blocks left to download

onChainDownloadStarted

public void onChainDownloadStarted(Peer peer,
                                   int blocksLeft)

Description copied from interface: ChainDownloadStartedEventListener

Called when a download is started with the initial number of blocks to be downloaded.

Specified by:

onChainDownloadStarted in interface ChainDownloadStartedEventListener

Parameters:

peer - the peer receiving the block

blocksLeft - the number of blocks left to download

onPeerConnected

public void onPeerConnected(Peer peer,
                            int peerCount)

Description copied from interface: PeerConnectedEventListener

Called when a peer is connected. If this listener is registered to a Peer instead of a PeerGroup, peerCount will always be 1.

Specified by:

onPeerConnected in interface PeerConnectedEventListener

peerCount - the total number of connected peers

onPeerDisconnected

public void onPeerDisconnected(Peer peer,
                               int peerCount)

Description copied from interface: PeerConnectionEventListener

Called when a peer is disconnected. Note that this won't be called if the listener is registered on a PeerGroup and the group is in the process of shutting down. If this listener is registered to a Peer instead of a PeerGroup, peerCount will always be 0. This handler can be called without a corresponding invocation of onPeerConnected if the initial connection is never successful.

Specified by:

onPeerDisconnected in interface PeerConnectionEventListener

Specified by:

onPeerDisconnected in interface PeerDisconnectedEventListener

peerCount - the total number of connected peers

onPreMessageReceived

public Message onPreMessageReceived(Peer peer,
                                    Message m)

Description copied from interface: PreMessageReceivedEventListener

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.

Note that this will never be called if registered with any executor other than Threading.SAME_THREAD

Specified by:

onPreMessageReceived in interface PreMessageReceivedEventListener

onTransaction

public void onTransaction(Peer peer,
                          Transaction t)

Description copied from interface: OnTransactionBroadcastListener

Called when a new transaction is broadcast over the network.

Specified by:

onTransaction in interface OnTransactionBroadcastListener

getData

public List<Message> getData(Peer peer,
                             GetDataMessage m)

Description copied from interface: GetDataEventListener

Called when a peer receives a getdata message, usually in response to an "inv" being broadcast. Return as many items as possible which appear in the GetDataMessage, or null if you're not interested in responding.

Note that this will never be called if registered with any executor other than Threading.SAME_THREAD

Specified by:

getData in interface GetDataEventListener