Core-ipv6

This module includes definitions for the IPv6 network layer. More...

Modules
	ICMPv6
	This module includes definitions for ICMPv6.
	IPv6
	This module includes definitions for core IPv6 networking.
	MPL
	This module includes definitions for MPL.
	Network Interfaces
	This module includes definitions for IPv6 network interfaces.

Classes
class	ot::Ip6::Filter
	This class implements an IPv6 datagram filter. More...

Functions
	ot::Ip6::Filter::Filter (void)
	This constructor initializes the Filter object.
bool	ot::Ip6::Filter::Accept (Message &aMessage) const
	This method indicates whether or not the IPv6 datagram passes the filter. More...
otError	ot::Ip6::Filter::AddUnsecurePort (uint16_t aPort)
	This method adds a port to the allowed unsecured port list. More...
otError	ot::Ip6::Filter::RemoveUnsecurePort (uint16_t aPort)
	This method removes a port from the allowed unsecure port list. More...
const uint16_t *	ot::Ip6::Filter::GetUnsecurePorts (uint8_t &aNumEntries) const
	This method returns a pointer to the unsecure port list. More...

Detailed Description

This module includes definitions for the IPv6 network layer.

This module includes definitions for IPv6 datagram filtering.

Function Documentation

Accept()

bool ot::Ip6::Filter::Accept

(

Message &

aMessage

)

const

This method indicates whether or not the IPv6 datagram passes the filter.

Parameters

[in]

aMessage

The IPv6 datagram to process.

Return values

TRUE	Accept the IPv6 datagram.
FALSE	Reject the IPv6 datagram.

AddUnsecurePort()

otError ot::Ip6::Filter::AddUnsecurePort

(

uint16_t

aPort

)

This method adds a port to the allowed unsecured port list.

Parameters

[in]

aPort

The port value.

Return values

OT_ERROR_NONE	The port was successfully added to the allowed unsecure port list.
OT_ERROR_NO_BUFS	The unsecure port list is full.

GetUnsecurePorts()

const uint16_t * ot::Ip6::Filter::GetUnsecurePorts

(

uint8_t &

aNumEntries

)

const

This method returns a pointer to the unsecure port list.

Note

Port value 0 is used to indicate an invalid entry.

Parameters

[out]

aNumEntries

The number of entries in the list.

Returns

A pointer to the unsecure port list.

RemoveUnsecurePort()

otError ot::Ip6::Filter::RemoveUnsecurePort

(

uint16_t

aPort

)

This method removes a port from the allowed unsecure port list.

Parameters

[in]

aPort

The port value.

Return values

OT_ERROR_NONE	The port was successfully removed from the allowed unsecure port list.
OT_ERROR_NOT_FOUND	The port was not found in the unsecure port list.