Package org.bitcoinj.core

Class MessageSerializer

java.lang.Object

org.bitcoinj.core.MessageSerializer

Direct Known Subclasses:

BitcoinSerializer

public abstract class MessageSerializer
extends java.lang.Object

Generic interface for classes which serialize/deserialize messages. Implementing classes should be immutable.

Constructor Summary

Constructors

Constructor	Description
MessageSerializer()

Method Summary

Modifier and Type	Method	Description
abstract Message	deserialize(java.nio.ByteBuffer in)	Reads a message from the given ByteBuffer and returns it.
abstract BitcoinSerializer.BitcoinPacketHeader	deserializeHeader(java.nio.ByteBuffer in)	Deserializes only the header in case packet meta data is needed before decoding the payload.
abstract Message	deserializePayload(BitcoinSerializer.BitcoinPacketHeader header, java.nio.ByteBuffer in)	Deserialize payload only.
abstract int	getProtocolVersion()	Get the protocol version of this serializer.
abstract boolean	isParseRetainMode()	Whether the serializer will produce cached mode Messages
abstract AddressV1Message	makeAddressV1Message(byte[] payloadBytes, int length)	Make an address message from the payload.
abstract AddressV2Message	makeAddressV2Message(byte[] payloadBytes, int length)	Make an address message from the payload.
Block	makeBlock(byte[] payloadBytes)	Make a block from the payload, using an offset of zero and the payload length as block length.
Block	makeBlock(byte[] payloadBytes, int length)	Make a block from the payload, using an offset of zero and the provided length as block length.
abstract Block	makeBlock(byte[] payloadBytes, int offset, int length)	Make a block from the payload, using an offset of zero and the provided length as block length.
abstract Message	makeBloomFilter(byte[] payloadBytes)	Make an filter message from the payload.
abstract FilteredBlock	makeFilteredBlock(byte[] payloadBytes)	Make a filtered block from the payload.
abstract InventoryMessage	makeInventoryMessage(byte[] payloadBytes, int length)	Make an inventory message from the payload.
Transaction	makeTransaction(byte[] payloadBytes)	Make a transaction from the payload.
Transaction	makeTransaction(byte[] payloadBytes, int offset)	Make a transaction from the payload.
abstract Transaction	makeTransaction(byte[] payloadBytes, int offset, int length, byte[] hash)	Make a transaction from the payload.
abstract void	seekPastMagicBytes(java.nio.ByteBuffer in)
abstract void	serialize(java.lang.String name, byte[] message, java.io.OutputStream out)	Writes message to to the output stream.
abstract void	serialize(Message message, java.io.OutputStream out)	Writes message to to the output stream.
abstract MessageSerializer	withProtocolVersion(int protocolVersion)	Create a new serializer with a specific protocol version.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageSerializer

public MessageSerializer()

Method Detail

withProtocolVersion

public abstract MessageSerializer withProtocolVersion(int protocolVersion)

Create a new serializer with a specific protocol version. Mainly used to disable SegWit when parsing transactions.

getProtocolVersion

public abstract int getProtocolVersion()

Get the protocol version of this serializer.

deserialize

public abstract Message deserialize(java.nio.ByteBuffer in)
                             throws ProtocolException,
                                    java.io.IOException,
                                    java.lang.UnsupportedOperationException

Reads a message from the given ByteBuffer and returns it.

Throws:

ProtocolException

java.io.IOException

java.lang.UnsupportedOperationException

deserializeHeader

public abstract BitcoinSerializer.BitcoinPacketHeader deserializeHeader(java.nio.ByteBuffer in)
                                                                 throws ProtocolException,
                                                                        java.io.IOException,
                                                                        java.lang.UnsupportedOperationException

Deserializes only the header in case packet meta data is needed before decoding the payload. This method assumes you have already called seekPastMagicBytes()

Throws:

ProtocolException

java.io.IOException

java.lang.UnsupportedOperationException

deserializePayload

public abstract Message deserializePayload(BitcoinSerializer.BitcoinPacketHeader header,
                                           java.nio.ByteBuffer in)
                                    throws ProtocolException,
                                           java.nio.BufferUnderflowException,
                                           java.lang.UnsupportedOperationException

Deserialize payload only. You must provide a header, typically obtained by calling BitcoinSerializer.deserializeHeader(java.nio.ByteBuffer).

Throws:

ProtocolException

java.nio.BufferUnderflowException

java.lang.UnsupportedOperationException

isParseRetainMode

public abstract boolean isParseRetainMode()

Whether the serializer will produce cached mode Messages

makeAddressV1Message

public abstract AddressV1Message makeAddressV1Message(byte[] payloadBytes,
                                                      int length)
                                               throws ProtocolException,
                                                      java.lang.UnsupportedOperationException

Make an address message from the payload. Extension point for alternative serialization format support.

Throws:

ProtocolException

java.lang.UnsupportedOperationException

makeAddressV2Message

public abstract AddressV2Message makeAddressV2Message(byte[] payloadBytes,
                                                      int length)
                                               throws ProtocolException,
                                                      java.lang.UnsupportedOperationException

Make an address message from the payload. Extension point for alternative serialization format support.

Throws:

ProtocolException

java.lang.UnsupportedOperationException

makeBlock

public final Block makeBlock(byte[] payloadBytes)
                      throws ProtocolException

Make a block from the payload, using an offset of zero and the payload length as block length.

Throws:

ProtocolException

makeBlock

public final Block makeBlock(byte[] payloadBytes,
                             int length)
                      throws ProtocolException

Make a block from the payload, using an offset of zero and the provided length as block length.

Throws:

ProtocolException

makeBlock

public abstract Block makeBlock(byte[] payloadBytes,
                                int offset,
                                int length)
                         throws ProtocolException,
                                java.lang.UnsupportedOperationException

Make a block from the payload, using an offset of zero and the provided length as block length. Extension point for alternative serialization format support.

Throws:

ProtocolException

java.lang.UnsupportedOperationException

makeBloomFilter

public abstract Message makeBloomFilter(byte[] payloadBytes)
                                 throws ProtocolException,
                                        java.lang.UnsupportedOperationException

Make an filter message from the payload. Extension point for alternative serialization format support.

Throws:

ProtocolException

java.lang.UnsupportedOperationException

makeFilteredBlock

public abstract FilteredBlock makeFilteredBlock(byte[] payloadBytes)
                                         throws ProtocolException,
                                                java.lang.UnsupportedOperationException

Make a filtered block from the payload. Extension point for alternative serialization format support.

Throws:

ProtocolException

java.lang.UnsupportedOperationException

makeInventoryMessage

public abstract InventoryMessage makeInventoryMessage(byte[] payloadBytes,
                                                      int length)
                                               throws ProtocolException,
                                                      java.lang.UnsupportedOperationException

Make an inventory message from the payload. Extension point for alternative serialization format support.

Throws:

ProtocolException

java.lang.UnsupportedOperationException

makeTransaction

public abstract Transaction makeTransaction(byte[] payloadBytes,
                                            int offset,
                                            int length,
                                            byte[] hash)
                                     throws ProtocolException,
                                            java.lang.UnsupportedOperationException

Make a transaction from the payload. Extension point for alternative serialization format support.

Throws:

java.lang.UnsupportedOperationException - if this serializer/deserializer does not support deserialization. This can occur either because it's a dummy serializer (i.e. for messages with no network parameters), or because it does not support deserializing transactions.

ProtocolException

makeTransaction

public final Transaction makeTransaction(byte[] payloadBytes)
                                  throws ProtocolException,
                                         java.lang.UnsupportedOperationException

Make a transaction from the payload. Extension point for alternative serialization format support.

Throws:

java.lang.UnsupportedOperationException - if this serializer/deserializer does not support deserialization. This can occur either because it's a dummy serializer (i.e. for messages with no network parameters), or because it does not support deserializing transactions.

ProtocolException

makeTransaction

public final Transaction makeTransaction(byte[] payloadBytes,
                                         int offset)
                                  throws ProtocolException

Make a transaction from the payload. Extension point for alternative serialization format support.

Throws:

java.lang.UnsupportedOperationException - if this serializer/deserializer does not support deserialization. This can occur either because it's a dummy serializer (i.e. for messages with no network parameters), or because it does not support deserializing transactions.

ProtocolException

seekPastMagicBytes

public abstract void seekPastMagicBytes(java.nio.ByteBuffer in)
                                 throws java.nio.BufferUnderflowException

Throws:

java.nio.BufferUnderflowException

serialize

public abstract void serialize(java.lang.String name,
                               byte[] message,
                               java.io.OutputStream out)
                        throws java.io.IOException,
                               java.lang.UnsupportedOperationException

Writes message to to the output stream.

Throws:

java.lang.UnsupportedOperationException - if this serializer/deserializer does not support serialization. This can occur either because it's a dummy serializer (i.e. for messages with no network parameters), or because it does not support serializing the given message.

java.io.IOException

serialize

public abstract void serialize(Message message,
                               java.io.OutputStream out)
                        throws java.io.IOException,
                               java.lang.UnsupportedOperationException

Writes message to to the output stream.

Throws:

java.lang.UnsupportedOperationException - if this serializer/deserializer does not support serialization. This can occur either because it's a dummy serializer (i.e. for messages with no network parameters), or because it does not support serializing the given message.

java.io.IOException