diff --git a/core/src/main/java/org/bitcoinj/core/Peer.java b/core/src/main/java/org/bitcoinj/core/Peer.java index 64d678240..1ec7b7d03 100644 --- a/core/src/main/java/org/bitcoinj/core/Peer.java +++ b/core/src/main/java/org/bitcoinj/core/Peer.java @@ -1254,7 +1254,7 @@ public class Peer extends PeerSocketHandler { } if (pingAfterGetData) - sendMessage(new Ping((long) (Math.random() * Long.MAX_VALUE))); + sendMessage(Ping.random()); } /** @@ -1555,7 +1555,7 @@ public class Peer extends PeerSocketHandler { } PendingPing pendingPing = new PendingPing(nonce); pendingPings.add(pendingPing); - sendMessage(new Ping(pendingPing.nonce)); + sendMessage(Ping.of(pendingPing.nonce)); return pendingPing.future; } @@ -1603,13 +1603,13 @@ public class Peer extends PeerSocketHandler { } private void processPing(Ping m) { - sendMessage(new Pong(m.getNonce())); + sendMessage(m.pong()); } protected void processPong(Pong m) { // Iterates over a snapshot of the list, so we can run unlocked here. for (PendingPing ping : pendingPings) { - if (m.getNonce() == ping.nonce) { + if (m.nonce() == ping.nonce) { pendingPings.remove(ping); // This line may trigger an event listener that re-runs ping(). ping.complete(); @@ -1770,7 +1770,7 @@ public class Peer extends PeerSocketHandler { // TODO: This bizarre ping-after-getdata hack probably isn't necessary. // It's to ensure we know when the end of a filtered block stream of txns is, but we should just be // able to match txns with the merkleblock. Ask Matt why it's written this way. - sendMessage(new Ping((long) (Math.random() * Long.MAX_VALUE))); + sendMessage(Ping.random()); }, Threading.SAME_THREAD); } finally { lock.unlock(); diff --git a/core/src/main/java/org/bitcoinj/core/Ping.java b/core/src/main/java/org/bitcoinj/core/Ping.java index c8992ee23..de3b317c5 100644 --- a/core/src/main/java/org/bitcoinj/core/Ping.java +++ b/core/src/main/java/org/bitcoinj/core/Ping.java @@ -1,6 +1,5 @@ /* - * Copyright 2011 Noa Resare - * Copyright 2015 Andreas Schildbach + * Copyright by the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -26,12 +25,12 @@ import java.nio.ByteBuffer; import java.util.Random; /** - *
See BIP31 for details.
- * - *Instances of this class are not safe for use by multiple threads.
+ * See BIP31 for details. + *+ * Instances of this class are immutable. */ public class Ping extends BaseMessage { - private long nonce; + private final long nonce; /** * Deserialize this message from a given payload. @@ -45,17 +44,29 @@ public class Ping extends BaseMessage { } /** - * Create a Ping with a given nonce value. + * Create a ping with a nonce value. + * Only use this if the remote node has a protocol version greater than 60000 + * + * @param nonce nonce value + * @return ping message */ - public Ping(long nonce) { - this.nonce = nonce; + public static Ping of(long nonce) { + return new Ping(nonce); } /** - * Create a Ping with a random nonce value. + * Create a ping with a random nonce value. + * Only use this if the remote node has a protocol version greater than 60000 + * + * @return ping message */ - public Ping() { - this.nonce = new Random().nextLong(); + public static Ping random() { + long nonce = new Random().nextLong(); + return new Ping(nonce); + } + + private Ping(long nonce) { + this.nonce = nonce; } @Override @@ -69,7 +80,16 @@ public class Ping extends BaseMessage { return true; } - public long getNonce() { + public long nonce() { return nonce; } + + /** + * Create a {@link Pong} reply to this ping. + * + * @return pong message + */ + public Pong pong() { + return Pong.of(nonce); + } } diff --git a/core/src/main/java/org/bitcoinj/core/Pong.java b/core/src/main/java/org/bitcoinj/core/Pong.java index 75ed02f31..a5a107f6c 100644 --- a/core/src/main/java/org/bitcoinj/core/Pong.java +++ b/core/src/main/java/org/bitcoinj/core/Pong.java @@ -1,6 +1,5 @@ /* - * Copyright 2012 Matt Corallo - * Copyright 2015 Andreas Schildbach + * Copyright by the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,12 +24,12 @@ import java.nio.BufferUnderflowException; import java.nio.ByteBuffer; /** - *
See BIP31 for details.
- * - *Instances of this class are not safe for use by multiple threads.
+ * See BIP31 for details. + *
+ * Instances of this class are immutable.
*/
public class Pong extends BaseMessage {
- private long nonce;
+ private final long nonce;
/**
* Deserialize this message from a given payload.
@@ -42,12 +41,18 @@ public class Pong extends BaseMessage {
public static Pong read(ByteBuffer payload) throws BufferUnderflowException, ProtocolException {
return new Pong(ByteUtils.readInt64(payload));
}
-
+
/**
- * Create a Pong with a nonce value.
- * Only use this if the remote node has a protocol version greater than 60000
+ * Create a pong with a nonce value.
+ *
+ * @param nonce nonce value
+ * @return pong message
*/
- public Pong(long nonce) {
+ public static Pong of(long nonce) {
+ return new Pong(nonce);
+ }
+
+ private Pong(long nonce) {
this.nonce = nonce;
}
@@ -57,7 +62,7 @@ public class Pong extends BaseMessage {
}
/** Returns the nonce sent by the remote peer. */
- public long getNonce() {
+ public long nonce() {
return nonce;
}
}
diff --git a/integration-test/src/test/java/org/bitcoinj/core/FilteredBlockAndPartialMerkleTreeTest.java b/integration-test/src/test/java/org/bitcoinj/core/FilteredBlockAndPartialMerkleTreeTest.java
index 2353a878b..34844d1d6 100644
--- a/integration-test/src/test/java/org/bitcoinj/core/FilteredBlockAndPartialMerkleTreeTest.java
+++ b/integration-test/src/test/java/org/bitcoinj/core/FilteredBlockAndPartialMerkleTreeTest.java
@@ -209,7 +209,7 @@ public class FilteredBlockAndPartialMerkleTreeTest extends TestWithPeerGroup {
inbound(p1, tx1);
inbound(p1, tx2);
inbound(p1, tx3);
- inbound(p1, new Pong(((Ping)ping).getNonce()));
+ inbound(p1, ((Ping) ping).pong());
pingAndWait(p1);
diff --git a/integration-test/src/test/java/org/bitcoinj/core/PeerGroupTest.java b/integration-test/src/test/java/org/bitcoinj/core/PeerGroupTest.java
index 839621be4..64361ebfb 100644
--- a/integration-test/src/test/java/org/bitcoinj/core/PeerGroupTest.java
+++ b/integration-test/src/test/java/org/bitcoinj/core/PeerGroupTest.java
@@ -473,12 +473,12 @@ public class PeerGroupTest extends TestWithPeerGroup {
versionMessage.localServices = Services.of(Services.NODE_NETWORK);
InboundMessageQueuer p1 = connectPeer(1, versionMessage);
Ping ping = (Ping) waitForOutbound(p1);
- inbound(p1, new Pong(ping.getNonce()));
+ inbound(p1, ping.pong());
pingAndWait(p1);
assertTrue(peerGroup.getConnectedPeers().get(0).lastPingInterval().isPresent());
// The call to outbound should block until a ping arrives.
ping = (Ping) waitForOutbound(p1);
- inbound(p1, new Pong(ping.getNonce()));
+ inbound(p1, ping.pong());
assertTrue(peerGroup.getConnectedPeers().get(0).lastPingInterval().isPresent());
}
@@ -844,7 +844,7 @@ public class PeerGroupTest extends TestWithPeerGroup {
assertNotEquals(filter, newFilter);
assertNextMessageIs(p1, MemoryPoolMessage.class);
Ping ping = assertNextMessageIs(p1, Ping.class);
- inbound(p1, new Pong(ping.getNonce()));
+ inbound(p1, ping.pong());
// Await restart of the chain download.
GetDataMessage getdata = assertNextMessageIs(p1, GetDataMessage.class);
@@ -858,12 +858,12 @@ public class PeerGroupTest extends TestWithPeerGroup {
peerGroup.waitForJobQueue();
newFilter = assertNextMessageIs(p1, BloomFilter.class);
assertNextMessageIs(p1, MemoryPoolMessage.class);
- inbound(p1, new Pong(assertNextMessageIs(p1, Ping.class).getNonce()));
+ inbound(p1, assertNextMessageIs(p1, Ping.class).pong());
assertNextMessageIs(p1, GetDataMessage.class);
newBlocks = blocks.subList(6, blocks.size());
filterAndSend(p1, newBlocks, newFilter);
// Send a non-tx message so the peer knows the filtered block is over and force processing.
- inbound(p1, new Ping());
+ inbound(p1, Ping.random());
pingAndWait(p1);
assertEquals(expectedBalance, wallet.getBalance());
diff --git a/integration-test/src/test/java/org/bitcoinj/core/PeerTest.java b/integration-test/src/test/java/org/bitcoinj/core/PeerTest.java
index a556da7bd..0825d27de 100644
--- a/integration-test/src/test/java/org/bitcoinj/core/PeerTest.java
+++ b/integration-test/src/test/java/org/bitcoinj/core/PeerTest.java
@@ -515,7 +515,7 @@ public class PeerTest extends TestWithNetworkConnections {
Ping pingMsg = (Ping) outbound(writeTarget);
TimeUtils.rollMockClock(Duration.ofSeconds(5));
// The pong is returned.
- inbound(writeTarget, new Pong(pingMsg.getNonce()));
+ inbound(writeTarget, pingMsg.pong());
pingAndWait(writeTarget);
assertTrue(future.isDone());
Duration elapsed = future.get();
@@ -526,7 +526,7 @@ public class PeerTest extends TestWithNetworkConnections {
CompletableFuture