message

Documentation

Index

• Variables
• func GetMID() uint16
• func RandMID() uint16
• type Message
  • func (m Message) Marshal() ([]byte, error)
  • func (m Message) MarshalTo(buf []byte) (int, error)
  • func (m Message) Size() (int, error)
  • func (m *Message) Unmarshal(data []byte) (int, error)
• type Type
  • func (t Type) String() string

Variables

var (
	ErrMessageTruncated      = errors.New("message is truncated")
	ErrMessageInvalidVersion = errors.New("message has invalid version")
)

Functions

func GetMID

func GetMID() uint16

GetMID generates a message id for UDP-coap

func RandMID

func RandMID() uint16

Types

type Message

type Message struct {
	Token   message.Token
	Payload []byte

	Options message.Options //Options must be sorted by ID
	Code    codes.Code

	MessageID uint16
	Type      Type
}

TcpMessage is a CoAP MessageBase that can encode itself for Message transport.

func (Message) Marshal

func (m Message) Marshal() ([]byte, error)

func (Message) MarshalTo

func (m Message) MarshalTo(buf []byte) (int, error)

func (Message) Size

func (m Message) Size() (int, error)

func (*Message) Unmarshal

func (m *Message) Unmarshal(data []byte) (int, error)

type Type

type Type uint8

Type represents the message type. It's only part of CoAP UDP messages. Reliable transports like TCP do not have a type.

const (
	// Confirmable messages require acknowledgements.
	Confirmable Type = 0
	// NonConfirmable messages do not require acknowledgements.
	NonConfirmable Type = 1
	// Acknowledgement is a message indicating a response to confirmable message.
	Acknowledgement Type = 2
	// Reset indicates a permanent negative acknowledgement.
	Reset Type = 3
)

func (Type) String

func (t Type) String() string