message

Documentation

Overview

Package message represents message that messagebus can route

Index

• func Deserialize(buf []byte) (insolar.Message, error)
• func DeserializeParcel(buff io.Reader) (insolar.Parcel, error)
• func MustSerialize(msg insolar.Message) []byte
• func ParcelMessageHash(pcs insolar.PlatformCryptographyScheme, parcel insolar.Parcel) []byte
• func ParcelToBytes(msg insolar.Parcel) []byte
• func SerializeParcel(parcel insolar.Parcel) (io.Reader, error)
• type GenesisRequest
  • func (*GenesisRequest) AllowedSenderObjectAndRole() (*insolar.Reference, insolar.DynamicRole)
  • func (*GenesisRequest) DefaultRole() insolar.DynamicRole
  • func (gr *GenesisRequest) DefaultTarget() *insolar.Reference
  • func (*GenesisRequest) GetCaller() *insolar.Reference
  • func (*GenesisRequest) Type() insolar.MessageType
• type Parcel
  • func (p *Parcel) AddDelegationToken(token insolar.DelegationToken)
  • func (p *Parcel) AllowedSenderObjectAndRole() (*insolar.Reference, insolar.DynamicRole)
  • func (p *Parcel) Context(ctx context.Context) context.Context
  • func (p *Parcel) DefaultRole() insolar.DynamicRole
  • func (p *Parcel) DefaultTarget() *insolar.Reference
  • func (p *Parcel) DelegationToken() insolar.DelegationToken
  • func (p *Parcel) GetCaller() *insolar.Reference
  • func (p *Parcel) GetSender() insolar.Reference
  • func (p *Parcel) GetSign() []byte
  • func (p *Parcel) Message() insolar.Message
  • func (p *Parcel) Pulse() insolar.PulseNumber
  • func (p *Parcel) SetSender(sender insolar.Reference)
  • func (p *Parcel) Type() insolar.MessageType
• type ParcelFactory
• type ServiceData
• type ValidationResults
  • func (vr *ValidationResults) AllowedSenderObjectAndRole() (*insolar.Reference, insolar.DynamicRole)
  • func (*ValidationResults) DefaultRole() insolar.DynamicRole
  • func (vr *ValidationResults) DefaultTarget() *insolar.Reference
  • func (vr *ValidationResults) GetCaller() *insolar.Reference
  • func (vr *ValidationResults) GetReference() insolar.Reference
  • func (vr *ValidationResults) Type() insolar.MessageType

Functions

func Deserialize

func Deserialize(buf []byte) (insolar.Message, error)

Deserialize returns decoded message.

func DeserializeParcel

func DeserializeParcel(buff io.Reader) (insolar.Parcel, error)

DeserializeParcel returns decoded signed message.

func MustSerialize

func MustSerialize(msg insolar.Message) []byte

MustSerialize serialize a insolar.Message to bytes.

func ParcelMessageHash

func ParcelMessageHash(pcs insolar.PlatformCryptographyScheme, parcel insolar.Parcel) []byte

ParcelMessageHash returns hash of parcel's message calculated with provided cryptography scheme.

func ParcelToBytes

func ParcelToBytes(msg insolar.Parcel) []byte

ParcelToBytes deserialize a insolar.Parcel to bytes.

func SerializeParcel

func SerializeParcel(parcel insolar.Parcel) (io.Reader, error)

SerializeParcel returns io.Reader on buffer with encoded insolar.Parcel.

Types

type GenesisRequest

type GenesisRequest struct {
	// Name should be unique for each genesis record.
	Name string
}

GenesisRequest is used for genesis records generation. this is fake message that never passed to messageBus it implements Message Interface for ability to be converted to Parcel and than be passed to RegisterRequest method

func (*GenesisRequest) AllowedSenderObjectAndRole

func (*GenesisRequest) AllowedSenderObjectAndRole() (*insolar.Reference, insolar.DynamicRole)

AllowedSenderObjectAndRole implements interface method

func (*GenesisRequest) DefaultRole

func (*GenesisRequest) DefaultRole() insolar.DynamicRole

DefaultRole returns role for this event

func (*GenesisRequest) DefaultTarget

func (gr *GenesisRequest) DefaultTarget() *insolar.Reference

DefaultTarget returns of target of this event.

func (*GenesisRequest) GetCaller

func (*GenesisRequest) GetCaller() *insolar.Reference

GetCaller implementation for genesis request.

func (*GenesisRequest) Type

func (*GenesisRequest) Type() insolar.MessageType

Type implementation for genesis request.

type Parcel

type Parcel struct {
	Sender      insolar.Reference
	Msg         insolar.Message
	Signature   []byte
	Token       insolar.DelegationToken
	PulseNumber insolar.PulseNumber
	ServiceData ServiceData
}

Parcel is a message signed by senders private key.

func (*Parcel) AddDelegationToken

func (p *Parcel) AddDelegationToken(token insolar.DelegationToken)

func (*Parcel) AllowedSenderObjectAndRole

func (p *Parcel) AllowedSenderObjectAndRole() (*insolar.Reference, insolar.DynamicRole)

AllowedSenderObjectAndRole implements interface method

func (*Parcel) Context

func (p *Parcel) Context(ctx context.Context) context.Context

Context returns initialized context with propagated data with ctx as parent.

func (*Parcel) DefaultRole

func (p *Parcel) DefaultRole() insolar.DynamicRole

DefaultRole returns role for this event

func (*Parcel) DefaultTarget

func (p *Parcel) DefaultTarget() *insolar.Reference

DefaultTarget returns of target of this event.

func (*Parcel) DelegationToken

func (p *Parcel) DelegationToken() insolar.DelegationToken

func (*Parcel) GetCaller

func (p *Parcel) GetCaller() *insolar.Reference

GetCaller returns initiator of this event.

func (*Parcel) GetSender

func (p *Parcel) GetSender() insolar.Reference

func (*Parcel) GetSign

func (p *Parcel) GetSign() []byte

func (*Parcel) Message

func (p *Parcel) Message() insolar.Message

Message returns current instance's message

func (*Parcel) Pulse

func (p *Parcel) Pulse() insolar.PulseNumber

Pulse returns pulse, when parcel was sent

func (*Parcel) SetSender

func (p *Parcel) SetSender(sender insolar.Reference)

func (*Parcel) Type

func (p *Parcel) Type() insolar.MessageType

Type returns message type.

type ParcelFactory

type ParcelFactory interface {
	Create(context.Context, insolar.Message, insolar.Reference, insolar.DelegationToken, insolar.Pulse) (insolar.Parcel, error)
	Validate(crypto.PublicKey, insolar.Parcel) error
}

ParcelFactory is used for creating parcels

type ServiceData

type ServiceData struct {
	LogTraceID    string
	LogLevel      insolar.LogLevel
	TraceSpanData []byte
}

ServiceData is a structure with utility fields like log level and trace id.

type ValidationResults

type ValidationResults struct {
	Caller           insolar.Reference
	RecordRef        insolar.Reference
	PassedStepsCount int
	Error            string
}

func (*ValidationResults) AllowedSenderObjectAndRole

func (vr *ValidationResults) AllowedSenderObjectAndRole() (*insolar.Reference, insolar.DynamicRole)

AllowedSenderObjectAndRole implements interface method

func (*ValidationResults) DefaultRole

func (*ValidationResults) DefaultRole() insolar.DynamicRole

DefaultRole returns role for this event

func (*ValidationResults) DefaultTarget

func (vr *ValidationResults) DefaultTarget() *insolar.Reference

DefaultTarget returns of target of this event.

func (*ValidationResults) GetCaller

func (vr *ValidationResults) GetCaller() *insolar.Reference

TODO change after changing pulsar

func (*ValidationResults) GetReference

func (vr *ValidationResults) GetReference() insolar.Reference

func (*ValidationResults) Type

func (vr *ValidationResults) Type() insolar.MessageType