header

Documentation

Index

• Constants
• type Header
  • func FromBytes(bytes []byte, optionalTargetObject ...*Header) (result Header, consumedBytes int, err error)
  • func New(payloadType Type, instanceID uint32) Header
  • func Parse(marshalUtil *marshalutil.MarshalUtil) (Header, error)
  • func (header *Header) Bytes() (bytes []byte)
• type Type

Constants

const Length = 5

Length defines the length of a DRNG header

Types

type Header

type Header struct {
	PayloadType Type   // message type
	InstanceID  uint32 // identifier of the DRNG instance
}

Header defines defines a DRNG payload header

func FromBytes

func FromBytes(bytes []byte, optionalTargetObject ...*Header) (result Header, consumedBytes int, err error)

FromBytes unmarshals a header from a sequence of bytes. It either creates a new header or fills the optionally provided object with the parsed information.

func New

func New(payloadType Type, instanceID uint32) Header

New creates a new DRNG payload header for the given type and instance id.

func Parse

func Parse(marshalUtil *marshalutil.MarshalUtil) (Header, error)

Parse is a wrapper for simplified unmarshaling in a byte stream using the marshalUtil package.

func (*Header) Bytes

func (header *Header) Bytes() (bytes []byte)

Bytes returns the header in serialized bytes form.

type Type

type Type = byte

Type defines the data model of a DRNG payload type

const (
	// TypeCollectiveBeacon defines a CollectiveBeacon payload type
	TypeCollectiveBeacon Type = 1
)