bluetoe::link_layer::device_address Class Reference

data type containing a device address and the address type (public or random). More...

#include <bluetoe/utility/include/bluetoe/address.hpp>

Inheritance diagram for bluetoe::link_layer::device_address:

Public Member Functions
bool	is_random () const
	returns true, if this device address is a random device address.
bool	is_public () const
	shortcut for !is_random()
bool	is_static () const
	returns true, if the given address is a static device address
bool	is_private () const
	returns true, if the given address is not a static device address
bool	is_resolvable () const
	returns true, if the given address is private and resolvable
bool	is_random_resolvable () const
	returns true, if the address is random and resolvable
bool	operator== (const device_address &rhs) const
	returns true, if this device address is the same as the rhs device address
bool	operator!= (const device_address &rhs) const
	returns false, if this device address is the same as the rhs device address
	device_address (const std::initializer_list< std::uint8_t > &initial_values, bool is_random)
	initialize an address by a initializer list with exactly 6 elements and a flag indicating whether this address is a random address or not.
	device_address (const std::uint8_t *initial_values, bool is_random)
	initializing an address by taking 6 bytes from the given start of an array and a flag indicating whether this address is a random address or not.
bool	operator== (const address &rhs) const
	returns true, if this address is the same as the rhs address
bool	operator!= (const address &rhs) const
	returns false, if this address is the same as the rhs address
Public Member Functions inherited from bluetoe::link_layer::address
	address ()
	creates the address with all octes beeing zero (00:00:00:00:00:00)
	address (const std::initializer_list< std::uint8_t > &initial_values)
	initialize an address by a initializer list with exactly 6 elements
	address (const std::uint8_t *initial_values)
	initializing an address by taking 6 bytes from the given start of an array
std::ostream &	print (std::ostream &) const
	prints this in a human readable manner
std::uint8_t	msb () const
	returns the most significant byte of the address
bool	operator== (const address &rhs) const
	returns true, if this address is the same as the rhs address
bool	operator!= (const address &rhs) const
	returns false, if this address is the same as the rhs address
const_iterator	begin () const
	returns an iterator to the first byte (LSB) of the address
const_iterator	end () const
	returns an iterator one behind the last byte of the address

Protected Member Functions
	device_address (bool is_random)
	constructs a public or random default device address (00:00:00:00:00:00)

Additional Inherited Members
Public Types inherited from bluetoe::link_layer::address
typedef std::uint8_t const *	const_iterator
	random access iterator
Static Public Member Functions inherited from bluetoe::link_layer::address
static random_device_address	generate_static_random_address (std::uint32_t seed)
	generates a valid static random address out of a given seed value
template<typename HashFunc >
static random_device_address	generate_resolvable_private_address (const std::uint8_t *irk, std::uint32_t random, HashFunc hash_func)
	generates a resolvable private address

Detailed Description

data type containing a device address and the address type (public or random).

A device address can either be a public or a random device address. To construct one or the othere, use the subtypes public_device_address and random_device_address.

Member Function Documentation

is_private()

bool bluetoe::link_layer::device_address::is_private ( ) const

inline

returns true, if the given address is not a static device address

Precondition

is_random() == true

is_resolvable()

bool bluetoe::link_layer::device_address::is_resolvable ( ) const

inline

returns true, if the given address is private and resolvable

Precondition

is_random() == true

is_static()

bool bluetoe::link_layer::device_address::is_static ( ) const

inline

returns true, if the given address is a static device address

Precondition

is_random() == true

---

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

• bluetoe/utility/include/bluetoe/address.hpp