message

package

v0.5.8 Latest Latest Go to latest Published: Jan 15, 2021 License: GPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const TopicLength = 4

TopicLength sets the length of the message topic

View Source

var ErrIncorrectFlagsFieldLength = errors.New("Incorrect flags field length in message")

ErrIncorrectFlagsFieldLength is returned when the incoming flags field length is incorrect

This section is empty.

type Digest [digestLength]byte

Digest holds the digest of a message used for caching

type Flags struct {
	Raw       bool // message is flagged as raw or with external encryption
	Symmetric bool // message is symmetrically encrypted
}

Flags represents the possible PSS message flags

func (f *Flags) DecodeRLP(s *rlp.Stream) error

DecodeRLP implements the rlp.Decoder interface

func (f *Flags) EncodeRLP(w io.Writer) error

EncodeRLP implements the rlp.Encoder interface

type Message struct {
	To      []byte
	Flags   Flags
	Expire  uint32
	Topic   Topic
	Payload []byte
}

Message encapsulates messages transported over pss.

func New(flags Flags) *Message

New creates a new PSS message

func (msg *Message) Digest() Digest

Digest computes a message digest for use as a cache key

func (msg *Message) String() string

String representation of a PSS message

type Topic [TopicLength]byte

Topic is the PSS encapsulation of the Whisper topic type

func NewTopic(b []byte) Topic

NewTopic hashes an arbitrary length byte slice and truncates it to the length of a topic, using only the first bytes of the digest

func (t Topic) MarshalJSON() (b []byte, err error)

MarshalJSON implements the json.Marshaler interface

func (t *Topic) String() string

func (t *Topic) UnmarshalJSON(input []byte) error

UnmarshalJSON implements the json.Marshaler interface