message

Documentation

Index

• Constants
• 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)
  • func (m *Message) UnmarshalWithHeader(header MessageHeader, data []byte) (int, error)
• type MessageHeader
  • func (i *MessageHeader) Unmarshal(data []byte) error

Constants

const (
	MaxMessageSize    message.OptionID = 2
	BlockWiseTransfer message.OptionID = 4
)

const (
	AlternativeAddress message.OptionID = 2
	HoldOff            message.OptionID = 4
)

const (
	BadCSMOption message.OptionID = 2
)

Signal Abort Option IDs

+-----+---+---+---------------------+--------+--------+---------+
| No. | C | R | Name                | Format | Length | Default |
+-----+---+---+---------------------+--------+--------+---------+
|   2 |   |   | Bad-CSM-Option      | uint   | 0-2    | (none)  |
+-----+---+---+---------------------+--------+--------+---------+
C=Critical, R=Repeatable

const (
	Custody message.OptionID = 2
)

Types

type Message

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

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

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)

func (*Message) UnmarshalWithHeader

func (m *Message) UnmarshalWithHeader(header MessageHeader, data []byte) (int, error)

type MessageHeader

type MessageHeader struct {
	Token     []byte
	HeaderLen uint32
	TotalLen  uint32
	Code      codes.Code
}

func (*MessageHeader) Unmarshal

func (i *MessageHeader) Unmarshal(data []byte) error

Unmarshal infers information about a Message CoAP message from the first fragment.