codec

Documentation

Index

• func InterfaceFromMessageCode(code MessageCode) (interface{}, string, error)
• func IsErrInvalidEncoding(err error) bool
• func IsErrMsgUnmarshal(err error) bool
• func IsErrUnknownMsgCode(err error) bool
• type ErrInvalidEncoding
  • func NewInvalidEncodingErr(err error) ErrInvalidEncoding
  • func (e ErrInvalidEncoding) Error() string
• type ErrMsgUnmarshal
  • func NewMsgUnmarshalErr(code uint8, msgType string, err error) ErrMsgUnmarshal
  • func (e ErrMsgUnmarshal) Error() string
• type ErrUnknownMsgCode
  • func NewUnknownMsgCodeErr(code MessageCode) ErrUnknownMsgCode
  • func (e ErrUnknownMsgCode) Error() string
• type MessageCode
  • func MessageCodeFromInterface(v interface{}) (MessageCode, string, error)
  • func MessageCodeFromPayload(payload []byte) (MessageCode, error)
  • func (m MessageCode) Uint8() uint8

Functions

func InterfaceFromMessageCode

func InterfaceFromMessageCode(code MessageCode) (interface{}, string, error)

InterfaceFromMessageCode returns an interface with the correct underlying go type of the message code represents. Expected error returns during normal operations:

• ErrUnknownMsgCode if message code does not match any of the configured message codes above.

func IsErrInvalidEncoding

func IsErrInvalidEncoding(err error) bool

IsErrInvalidEncoding returns true if an error is ErrInvalidEncoding

func IsErrMsgUnmarshal

func IsErrMsgUnmarshal(err error) bool

IsErrMsgUnmarshal returns true if an error is ErrMsgUnmarshal

func IsErrUnknownMsgCode

func IsErrUnknownMsgCode(err error) bool

IsErrUnknownMsgCode returns true if an error is ErrUnknownMsgCode

Types

type ErrInvalidEncoding

type ErrInvalidEncoding struct {
	// contains filtered or unexported fields
}

ErrInvalidEncoding indicates that the message code byte (first byte of message payload) is unknown.

func NewInvalidEncodingErr

func NewInvalidEncodingErr(err error) ErrInvalidEncoding

NewInvalidEncodingErr returns a new ErrInvalidEncoding

func (ErrInvalidEncoding) Error

func (e ErrInvalidEncoding) Error() string

type ErrMsgUnmarshal

type ErrMsgUnmarshal struct {
	// contains filtered or unexported fields
}

ErrMsgUnmarshal indicates that the message could not be unmarshalled.

func NewMsgUnmarshalErr

func NewMsgUnmarshalErr(code uint8, msgType string, err error) ErrMsgUnmarshal

NewMsgUnmarshalErr returns a new ErrMsgUnmarshal

func (ErrMsgUnmarshal) Error

func (e ErrMsgUnmarshal) Error() string

type ErrUnknownMsgCode

type ErrUnknownMsgCode struct {
	// contains filtered or unexported fields
}

ErrUnknownMsgCode indicates that the message code byte (first byte of message payload) is unknown.

func NewUnknownMsgCodeErr

func NewUnknownMsgCodeErr(code MessageCode) ErrUnknownMsgCode

NewUnknownMsgCodeErr returns a new ErrUnknownMsgCode

func (ErrUnknownMsgCode) Error

func (e ErrUnknownMsgCode) Error() string

type MessageCode

type MessageCode uint8

const (
	CodeMin MessageCode = iota + 1

	// consensus
	CodeBlockProposal
	CodeBlockVote
	CodeTimeoutObject

	// protocol state sync
	CodeSyncRequest
	CodeSyncResponse
	CodeRangeRequest
	CodeBatchRequest
	CodeBlockResponse

	// cluster consensus
	CodeClusterBlockProposal
	CodeClusterBlockVote
	CodeClusterBlockResponse
	CodeClusterTimeoutObject

	// collections, guarantees & transactions
	CodeCollectionGuarantee
	CodeTransaction
	CodeTransactionBody

	// core messages for execution & verification
	CodeExecutionReceipt
	CodeResultApproval

	// data exchange for execution of blocks
	CodeChunkDataRequest
	CodeChunkDataResponse

	// result approvals
	CodeApprovalRequest
	CodeApprovalResponse

	// generic entity exchange engines
	CodeEntityRequest
	CodeEntityResponse

	// testing
	CodeEcho

	// DKG
	CodeDKGMessage

	CodeMax
)

func MessageCodeFromInterface

func MessageCodeFromInterface(v interface{}) (MessageCode, string, error)

MessageCodeFromInterface returns the correct Code based on the underlying type of message v.

func MessageCodeFromPayload

func MessageCodeFromPayload(payload []byte) (MessageCode, error)

MessageCodeFromPayload checks the length of the payload bytes before returning the first byte encoded MessageCode. Expected error returns during normal operations:

• ErrInvalidEncoding if payload is empty

func (MessageCode) Uint8

func (m MessageCode) Uint8() uint8