otbr::SteeringData Class Reference

#include <src/utils/steering_data.hpp>

Public Types
enum	{ kMaxSizeOfBloomFilter = 16, kSizeJoinerId = 8 }

Public Member Functions
void	Init (uint8_t aLength)
void	Clear (void)
void	Set (void)
void	SetBit (uint8_t aBit)
void	ComputeBloomFilter (const uint8_t *aJoinerId)
const uint8_t *	GetBloomFilter (void) const
uint8_t	GetLength (void) const

Static Public Member Functions
static void	ComputeJoinerId (const uint8_t *aEui64, uint8_t *aJoinerId)

Detailed Description

This class represents Steering Data

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kMaxSizeOfBloomFilter	Max length of bloom filter in bytes.
kSizeJoinerId	Size of Extended Joiner ID.

Member Function Documentation

Clear()

void otbr::SteeringData::Clear ( void  )

inline

This method sets all bits in the bloom filter to zero.

ComputeBloomFilter()

void otbr::SteeringData::ComputeBloomFilter

(

const uint8_t *

aJoinerId

)

This method computes the Bloom Filter.

Parameters

[in]

aJoinerId

Extended address

ComputeJoinerId()

void otbr::SteeringData::ComputeJoinerId ( const uint8_t *  aEui64, uint8_t *  aJoinerId  )

static

This method computes joiner id from EUI64.

Parameters

[in]	aEui64	A pointer to EUI64.
[out]	aJoinerId	A pointer to receive joiner id. This pointer can be the same as aEui64.

GetBloomFilter()

const uint8_t* otbr::SteeringData::GetBloomFilter ( void  ) const

inline

This method returns a pointer to the bloom filter.

Returns

A pointer to the computed bloom filter.

GetLength()

uint8_t otbr::SteeringData::GetLength ( void  ) const

inline

This method returns the length of the bloom filter.

Init()

void otbr::SteeringData::Init

(

uint8_t

aLength

)

This method initializes the bloom filter.

Parameters

[in]

aLength

The length of the bloom filter in bytes.

Set()

void otbr::SteeringData::Set ( void  )

inline

Ths method sets all bits in the bloom filter to one.

SetBit()

void otbr::SteeringData::SetBit ( uint8_t  aBit )

inline

This method sets bit aBit.

Parameters

[in]

aBit

The bit offset.

---

The documentation for this class was generated from the following files:

• src/utils/steering_data.hpp
• src/utils/steering_data.cpp