AddressMessage: add/update class-level JavaDoc

This commit is contained in:
Andreas Schildbach 2023-04-03 18:28:42 +02:00
parent e13e7db23c
commit 6bd8e8e6bc
3 changed files with 17 additions and 12 deletions

View File

@ -17,6 +17,7 @@
package org.bitcoinj.core;
import org.bitcoinj.base.VarInt;
import org.bitcoinj.net.discovery.PeerDiscovery;
import java.io.IOException;
import java.io.OutputStream;
@ -24,6 +25,10 @@ import java.nio.ByteBuffer;
import java.util.Collections;
import java.util.List;
/**
* Abstract superclass for address messages on the P2P network, which contain network addresses of other peers. This is
* one of the ways peers can find each other without using the {@link PeerDiscovery} mechanism.
*/
public abstract class AddressMessage extends Message {
protected static final long MAX_ADDRESSES = 1000;

View File

@ -19,17 +19,17 @@ package org.bitcoinj.core;
import org.bitcoinj.base.VarInt;
import org.bitcoinj.base.internal.InternalUtils;
import org.bitcoinj.net.discovery.PeerDiscovery;
import java.nio.BufferUnderflowException;
import java.nio.ByteBuffer;
import java.util.ArrayList;
/**
* <p>Represents an "addr" message on the P2P network, which contains broadcast IP addresses of other peers. This is
* one of the ways peers can find each other without using the DNS or IRC discovery mechanisms. However storing and
* using addr messages is not presently implemented.</p>
*
* <p>Instances of this class are not safe for use by multiple threads.</p>
* Represents an "addr" message on the P2P network, which contains broadcast IP addresses of other peers. This is
* one of the ways peers can find each other without using the {@link PeerDiscovery} mechanism.
* <p>
* Instances of this class are not safe for use by multiple threads.
*/
public class AddressV1Message extends AddressMessage {

View File

@ -18,19 +18,19 @@ package org.bitcoinj.core;
import org.bitcoinj.base.VarInt;
import org.bitcoinj.base.internal.InternalUtils;
import org.bitcoinj.net.discovery.PeerDiscovery;
import java.nio.BufferUnderflowException;
import java.nio.ByteBuffer;
import java.util.ArrayList;
/**
* <p>Represents an "addrv2" message on the P2P network, which contains broadcast IP addresses of other peers. This is
* one of the ways peers can find each other without using the DNS or IRC discovery mechanisms. However storing and
* using addrv2 messages is not presently implemented.</p>
*
* <p>See <a href="https://github.com/bitcoin/bips/blob/master/bip-0155.mediawiki">BIP155</a> for details.</p>
*
* <p>Instances of this class are not safe for use by multiple threads.</p>
* Represents an "addrv2" message on the P2P network, which contains broadcast addresses of other peers. This is
* one of the ways peers can find each other without using the {@link PeerDiscovery} mechanism.
* <p>
* See <a href="https://github.com/bitcoin/bips/blob/master/bip-0155.mediawiki">BIP155</a> for details.
* <p>
* Instances of this class are not safe for use by multiple threads.
*/
public class AddressV2Message extends AddressMessage {
/**