otHistoryTrackerMessageInfo

#include <history_tracker.h>

Represents a RX/TX IPv6 message info.

Summary

Some of the fields in this struct are applicable to a RX message or a TX message only, e.g., mAveRxRss is the average RSS of all fragment frames that form a received message and is only applicable for a RX message.

Public attributes
`mAveRxRss`	`int8_t` RSS of received message or OT_RADIO_INVALID_RSSI if not known.
`mChecksum`	`uint16_t` Message checksum (valid only for UDP/TCP/ICMP6).
`mDestination`	`otSockAddr` Destination IPv6 address and port (if UDP/TCP).
`mIcmp6Type`	`uint8_t` ICMP6 type if msg is ICMP6, zero otherwise (`OT_ICMP6_TYPE_*` enumeration).
`mIpProto`	`uint8_t` IP Protocol number (`OT_IP6_PROTO_*` enumeration).
`mLinkSecurity`	`bool` Indicates whether msg used link security.
`mNeighborRloc16`	`uint16_t` RLOC16 of neighbor which sent/received the msg (`0xfffe` if no RLOC16).
`mPayloadLength`	`uint16_t` IPv6 payload length (exclude IP6 header itself).
`mPriority`	`uint8_t` Message priority (`OT_HISTORY_TRACKER_MSG_PRIORITY_*` enumeration).
`mRadioIeee802154`	`bool` Indicates whether msg was sent/received over a 15.4 radio link.
`mRadioTrelUdp6`	`bool` Indicates whether msg was sent/received over a TREL radio link.
`mSource`	`otSockAddr` Source IPv6 address and port (if UDP/TCP)
`mTxSuccess`	`bool` Indicates TX success (e.g., ack received). Applicable for TX msg only.

Public attributes

mAveRxRss

int8_t otHistoryTrackerMessageInfo::mAveRxRss

RSS of received message or OT_RADIO_INVALID_RSSI if not known.

mChecksum

uint16_t otHistoryTrackerMessageInfo::mChecksum

Message checksum (valid only for UDP/TCP/ICMP6).

mDestination

otSockAddr otHistoryTrackerMessageInfo::mDestination

Destination IPv6 address and port (if UDP/TCP).

mIcmp6Type

uint8_t otHistoryTrackerMessageInfo::mIcmp6Type

ICMP6 type if msg is ICMP6, zero otherwise (OT_ICMP6_TYPE_* enumeration).

mIpProto

uint8_t otHistoryTrackerMessageInfo::mIpProto

IP Protocol number (OT_IP6_PROTO_* enumeration).

mLinkSecurity

bool otHistoryTrackerMessageInfo::mLinkSecurity

Indicates whether msg used link security.

mNeighborRloc16

uint16_t otHistoryTrackerMessageInfo::mNeighborRloc16

RLOC16 of neighbor which sent/received the msg (0xfffe if no RLOC16).

mPayloadLength

uint16_t otHistoryTrackerMessageInfo::mPayloadLength

IPv6 payload length (exclude IP6 header itself).

mPriority

uint8_t otHistoryTrackerMessageInfo::mPriority

Message priority (OT_HISTORY_TRACKER_MSG_PRIORITY_* enumeration).

mRadioIeee802154

bool otHistoryTrackerMessageInfo::mRadioIeee802154

Indicates whether msg was sent/received over a 15.4 radio link.

mRadioTrelUdp6

bool otHistoryTrackerMessageInfo::mRadioTrelUdp6

Indicates whether msg was sent/received over a TREL radio link.

mSource

otSockAddr otHistoryTrackerMessageInfo::mSource

Source IPv6 address and port (if UDP/TCP)

mTxSuccess

bool otHistoryTrackerMessageInfo::mTxSuccess

Indicates TX success (e.g., ack received). Applicable for TX msg only.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.