Symbols

loading (3/5)...

Files

loading (4/5)...

Summary Syntax Methods Related References Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Ip6::Headers

ot::Ip6::Headers class

This module includes definitions for ICMPv6.

Syntax

Show:

Summary

Declaration

Definition

from icmp6.hpp:61

class Headers;

Implemented in ip6.hpp:414

Fields

Field

Declared as

ot::Ip6::Headers::mIp6Header

Header

ot::Ip6::Headers::mHeader

union { Udp::Header mUdp; Tcp::Header mTcp; Icmp::Header mIcmp; }

Methods

ParseFrom()

Parses the IPv6 and UDP/TCP/ICMP6 headers from a given message.

DecompressFrom()

Decompresses lowpan frame and parses the IPv6 and UDP/TCP/ICMP6 headers.

DecompressFrom()

Decompresses lowpan frame and parses the IPv6 and UDP/TCP/ICMP6 headers.

GetIp6Header() const

Returns the IPv6 header.

GetIpProto() const

Returns the IP protocol number from IPv6 Next Header field.

GetEcn() const

Returns the 2-bit Explicit Congestion Notification (ECN) from Traffic Class field from IPv6 header.

IsUdp() const

Indicates if the protocol number from IPv6 header is UDP.

IsTcp() const

Indicates if the protocol number from IPv6 header is TCP.

IsIcmp6() const

Indicates if the protocol number from IPv6 header is ICMPv6.

GetSourceAddress() const

Returns the source IPv6 address from IPv6 header.

GetDestinationAddress() const

Returns the destination IPv6 address from IPv6 header.

GetUdpHeader() const

Returns the UDP header. MUST be used when `IsUdp() == true`. Otherwise its behavior is undefined.

GetTcpHeader() const

Returns the TCP header. MUST be used when `IsTcp() == true`. Otherwise its behavior is undefined.

GetIcmpHeader() const

Returns the ICMPv6 header. MUST be used when `IsIcmp6() == true`. Otherwise its behavior is undefined.

GetSourcePort() const

Returns the source port number if header is UDP or TCP, or zero otherwise.

GetDestinationPort() const

Returns the destination port number if header is UDP or TCP, or zero otherwise.

GetChecksum() const

Returns the checksum values from corresponding UDP, TCP, or ICMPv6 header.

References

Code

Location

Scope

Referrer

class Headers : private Clearable<Headers>

ip6.hpp:414

class Headers;

icmp6.hpp:61

Headers headers;

icmp6.cpp:80

ot::Ip6::Icmp::SendError()

Error Icmp::SendError(Header::Type aType, Header::Code aCode, const MessageInfo &aMessageInfo, const Headers &aHeaders)

icmp6.cpp:89

ot::Ip6::Icmp::SendError()

Error SendError(Header::Type aType, Header::Code aCode, const MessageInfo &aMessageInfo, const Headers &aHeaders);

icmp6.hpp:276

ot::Ip6::Icmp::SendError()

Error Headers::ParseFrom(const Message &aMessage)

ip6.cpp:1508

ot::Ip6::Headers::ParseFrom()

Error Headers::DecompressFrom(const Message &aMessage, uint16_t aOffset, const Mac::Addresses &aMacAddrs)

ip6.cpp:1537

ot::Ip6::Headers::DecompressFrom()

static constexpr uint16_t kReadLength = sizeof(Lowpan::FragmentHeader::NextFrag) + sizeof(Headers);

ip6.cpp:1539

ot::Ip6::Headers::DecompressFrom()

Error Headers::DecompressFrom(const FrameData &aFrameData, const Mac::Addresses &aMacAddrs, Instance &aInstance)

ip6.cpp:1551

ot::Ip6::Headers::DecompressFrom()

uint16_t Headers::GetSourcePort(void) const

ip6.cpp:1598

ot::Ip6::Headers::GetSourcePort() const

uint16_t Headers::GetDestinationPort(void) const

ip6.cpp:1619

ot::Ip6::Headers::GetDestinationPort() const

uint16_t Headers::GetChecksum(void) const

ip6.cpp:1640

ot::Ip6::Headers::GetChecksum() const

friend class Clearable<Headers>;

ip6.hpp:416

Headers headers;

ip6_filter.cpp:46

ot::Ip6::Filter::Accept() const

void MeshForwarder::LogIp6SourceDestAddresses(const Ip6::Headers &aHeaders, LogLevel aLogLevel)

mesh_forwarder.cpp:1807

ot::MeshForwarder::LogIp6SourceDestAddresses()

ot::MeshForwarder::LogIp6SourceDestAddresses()::aHeaders

Ip6::Headers headers;

mesh_forwarder.cpp:1840

ot::MeshForwarder::LogIp6Message()

Ip6::Headers mIp6Headers;

mesh_forwarder.hpp:401

ot::MeshForwarder::RxInfo

ot::MeshForwarder::RxInfo::mIp6Headers

void SendDestinationUnreachable(uint16_t aMeshSource, const Ip6::Headers &aIp6Headers);

mesh_forwarder.hpp:522

ot::MeshForwarder::SendDestinationUnreachable()

ot::MeshForwarder::SendDestinationUnreachable()::aIp6Headers

void LogIp6SourceDestAddresses(const Ip6::Headers &aHeaders, LogLevel aLogLevel);

mesh_forwarder.hpp:604

ot::MeshForwarder::LogIp6SourceDestAddresses()

ot::MeshForwarder::LogIp6SourceDestAddresses()::aHeaders

Ip6::Headers ip6Headers;

mesh_forwarder_ftd.cpp:468

ot::MeshForwarder::SendIcmpErrorIfDstUnreach()

void MeshForwarder::SendDestinationUnreachable(uint16_t aMeshSource, const Ip6::Headers &aIp6Headers)

mesh_forwarder_ftd.cpp:558

ot::MeshForwarder::SendDestinationUnreachable()

ot::MeshForwarder::SendDestinationUnreachable()::aIp6Headers

Ip6::Headers headers;

mesh_forwarder_ftd.cpp:904

ot::MeshForwarder::LogMeshIpHeader()

Call Tree

All items filtered out

Data Use

All items filtered out

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Instance

Scope

Location

Project

ot::MeshForwarder::RxInfo::mIp6Headers

ot::MeshForwarder::RxInfo

mesh_forwarder.hpp:401

ot::MeshForwarder::SendDestinationUnreachable()::aIp6Headers

ot::MeshForwarder::SendDestinationUnreachable()

mesh_forwarder.hpp:522

ot::MeshForwarder::LogIp6SourceDestAddresses()::aHeaders

ot::MeshForwarder::LogIp6SourceDestAddresses()

mesh_forwarder.hpp:604

ot::MeshForwarder::LogIp6SourceDestAddresses()::aHeaders

ot::MeshForwarder::LogIp6SourceDestAddresses()

mesh_forwarder.cpp:1807

ot::MeshForwarder::SendDestinationUnreachable()::aIp6Headers

ot::MeshForwarder::SendDestinationUnreachable()

mesh_forwarder_ftd.cpp:558

Lifecycle

All items filtered out

ot::Ip6::Headers class

Syntax

Fields

Methods

ParseFrom()

DecompressFrom()

DecompressFrom()

GetIp6Header() const

GetIpProto() const

GetEcn() const

IsUdp() const

IsTcp() const

IsIcmp6() const

GetSourceAddress() const

GetDestinationAddress() const

GetUdpHeader() const

GetTcpHeader() const

GetIcmpHeader() const

GetSourcePort() const

GetDestinationPort() const

GetChecksum() const

Related Functions

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle