message.go

package memp2p

import (
	"encoding/binary"

	"github.com/ElrondNetwork/elrond-go-core/core"
	"github.com/ElrondNetwork/elrond-go/p2p"
)

var _ p2p.MessageP2P = (*message)(nil)

// Message represents a message to be sent through the in-memory network
// simulated by the Network struct.
type message struct {
	from           []byte
	data           []byte
	seqNo          []byte
	topic          string
	signature      []byte
	key            []byte
	peer           core.PeerID
	payloadField   []byte
	timestampField int64
}

// NewMessage constructs a new Message instance from arguments
func newMessage(topic string, data []byte, peerID core.PeerID, seqNo uint64) *message {
	empty := make([]byte, 0)
	seqNoBytes := make([]byte, 8)
	binary.BigEndian.PutUint64(seqNoBytes, seqNo)

	return &message{
		from:      []byte(peerID),
		data:      data,
		seqNo:     seqNoBytes,
		topic:     topic,
		signature: empty,
		key:       []byte(peerID),
		peer:      peerID,
	}
}

// From returns the message originator's peer ID
func (msg *message) From() []byte {
	return msg.from
}

// Data returns the message payload
func (msg *message) Data() []byte {
	return msg.data
}

// SeqNo returns the message sequence number
func (msg *message) SeqNo() []byte {
	return msg.seqNo
}

// Topic returns the topic on which the message was sent
func (msg *message) Topic() string {
	return msg.topic
}

// Signature returns the message signature
func (msg *message) Signature() []byte {
	return msg.signature
}

// Key returns the message public key (if it can not be recovered from From field)
func (msg *message) Key() []byte {
	return msg.key
}

// Peer returns the peer that originated the message
func (msg *message) Peer() core.PeerID {
	return msg.peer
}

// Payload returns the encapsulated message along with meta data such as timestamp
func (msg *message) Payload() []byte {
	return msg.payloadField
}

// Timestamp returns the message timestamp to prevent endless re-processing of the same message
func (msg *message) Timestamp() int64 {
	return msg.timestampField
}

// IsInterfaceNil returns true if there is no value under the interface
func (msg *message) IsInterfaceNil() bool {
	return msg == nil
}