Rtos API example

Embed: (wiki syntax)

« Back to documentation index

address_t Struct Reference

MAC address data type. More...

#include <GapTypes.h>

Public Member Functions

 address_t ()
 Create an invalid mac address, equal to FF:FF:FF:FF:FF:FF.
 address_t (const uint8_t(&input_value)[6])
 Initialize a mac address from an array of bytes.
 address_t (const uint8_t *input_value, bool tag)
 Initialize a mac address from a pointer to a buffer.
uint8_t operator[] (uint8_t i) const
 Subscript operator to access mac address content.
const uint8_t * data () const
 Return the pointer to the buffer holding mac address.

Static Public Member Functions

static uint8_t size ()
 Size in byte of a mac address.

Friends

bool operator== (const address_t &lhs, const address_t &rhs)
 Equal operator between two addresses.
bool operator!= (const address_t &lhs, const address_t &rhs)
 Non equal operator between two addresses.

Detailed Description

MAC address data type.

Definition at line 416 of file GapTypes.h.


Constructor & Destructor Documentation

address_t (  )

Create an invalid mac address, equal to FF:FF:FF:FF:FF:FF.

Definition at line 420 of file GapTypes.h.

address_t ( const uint8_t(&)  input_value[6] )

Initialize a mac address from an array of bytes.

Parameters:
input_valuevalue of the MAC address.

Definition at line 429 of file GapTypes.h.

address_t ( const uint8_t *  input_value,
bool  tag 
)

Initialize a mac address from a pointer to a buffer.

Parameters:
input_valueBuffer containing the mac address. It shall be at least 6 long.
tagTag used to select this constructor. The value does not matter.

Definition at line 441 of file GapTypes.h.


Member Function Documentation

const uint8_t* data (  ) const

Return the pointer to the buffer holding mac address.

Definition at line 469 of file GapTypes.h.

uint8_t operator[] ( uint8_t  i ) const

Subscript operator to access mac address content.

Definition at line 462 of file GapTypes.h.

static uint8_t size (  ) [static]

Size in byte of a mac address.

Definition at line 476 of file GapTypes.h.


Friends And Related Function Documentation

bool operator!= ( const address_t lhs,
const address_t rhs 
) [friend]

Non equal operator between two addresses.

Definition at line 455 of file GapTypes.h.

bool operator== ( const address_t lhs,
const address_t rhs 
) [friend]

Equal operator between two addresses.

Definition at line 448 of file GapTypes.h.