Symbols

loading...

Files

loading (3/5)...

Summary Syntax Methods References Class Tree Instances

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

ot::Ip6::Filter class

Implements an IPv6 datagram filter.

Syntax

Show:

Summary

Declaration

from ip6_filter.hpp:59

class Filter : public InstanceLocator, private NonCopyable { public: explicit Filter(Instance &aInstance) : InstanceLocator(aInstance) { } bool Accept(Message &aMessage) const; Error AddUnsecurePort(uint16_t aPort) { return UpdateUnsecurePorts(kAdd, aPort); } Error RemoveUnsecurePort(uint16_t aPort) { return UpdateUnsecurePorts(kRemove, aPort); } bool IsUnsecurePort(uint16_t aPort) { return mUnsecurePorts.Contains(aPort); } void RemoveAllUnsecurePorts(void) { mUnsecurePorts.Clear(); } const uint16_t *GetUnsecurePorts(uint8_t &aNumEntries) const { aNumEntries = mUnsecurePorts.GetLength(); return &mUnsecurePorts[0]; } private: static constexpr uint16_t kMaxUnsecurePorts = 2; enum Action : uint8_t { kAdd, kRemove, }; Error UpdateUnsecurePorts(Action aAction, uint16_t aPort); Array<uint16_t, kMaxUnsecurePorts> mUnsecurePorts; };

Fields

Field

Declared as

ot::Ip6::Filter::kMaxUnsecurePorts

ot::Ip6::Filter::mUnsecurePorts

Array<uint16_t, kMaxUnsecurePorts>

Methods

Accept() const

Indicates whether or not the IPv6 datagram passes the filter.

AddUnsecurePort()

Adds a port to the allowed unsecured port list.

RemoveUnsecurePort()

Removes a port from the allowed unsecure port list.

IsUnsecurePort()

Checks whether a port is in the unsecure port list.

RemoveAllUnsecurePorts()

Removes all ports from the allowed unsecure port list.

GetUnsecurePorts() const

Returns a pointer to the unsecure port list.

UpdateUnsecurePorts()

References

Code

Location

Scope

Referrer

class Filter : public InstanceLocator, private NonCopyable

ip6_filter.hpp:59

Ip6::Filter mIp6Filter;

instance.hpp:547

ot::Instance::mIp6Filter

template <> inline Ip6::Filter &Instance::Get(void) { return mIp6Filter; }

instance.hpp:815

ot::Instance::Get()

return AsCoreType(aInstance).Get<Ip6::Filter>().AddUnsecurePort(aPort);

ip6_api.cpp:149

otIp6AddUnsecurePort()

return AsCoreType(aInstance).Get<Ip6::Filter>().RemoveUnsecurePort(aPort);

ip6_api.cpp:154

otIp6RemoveUnsecurePort()

AsCoreType(aInstance).Get<Ip6::Filter>().RemoveAllUnsecurePorts();

ip6_api.cpp:159

otIp6RemoveAllUnsecurePorts()

return AsCoreType(aInstance).Get<Ip6::Filter>().GetUnsecurePorts(*aNumEntries);

ip6_api.cpp:166

otIp6GetUnsecurePorts()

bool Filter::Accept(Message &aMessage) const

ip6_filter.cpp:43

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

Error Filter::UpdateUnsecurePorts(Action aAction, uint16_t aPort)

ip6_filter.cpp:101

ot::Ip6::Filter::UpdateUnsecurePorts()

IgnoreError(Get<Ip6::Filter>().AddUnsecurePort(port));

joiner_router.cpp:74

ot::MeshCoP::JoinerRouter::Start()

Get<Ip6::Filter>().GetUnsecurePorts(numUnsecurePorts);

ot::Mac::Mac::IsJoinable() const

VerifyOrExit(Get<Ip6::Filter>().Accept(*message), error = kErrorDrop);

mesh_forwarder.cpp:1500

ot::MeshForwarder::HandleFragment()

VerifyOrExit(Get<Ip6::Filter>().Accept(*message), error = kErrorDrop);

mesh_forwarder.cpp:1658

ot::MeshForwarder::HandleLowpanHc()

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

ot::Ip6::Filter is inherited by 2 classess:

ot::Ip6::Filter

ot::NonCopyable

ot::InstanceLocator

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Instance

Scope

Location

Project

ot::Instance::mIp6Filter

instance.hpp:547

return

ot::Instance::Get()

instance.hpp:815

Lifecycle

All items filtered out

All items filtered out