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()

Examples

References

from examples

ot::Ip6::Filter class

Syntax

Fields

Methods

Accept() const

AddUnsecurePort()

RemoveUnsecurePort()

IsUnsecurePort()

RemoveAllUnsecurePorts()

GetUnsecurePorts() const

UpdateUnsecurePorts()

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle