AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::avsCommon::utils::MacAddressString Class Reference

#include <MacAddressString.h>

Public Member Functions

 MacAddressString (const MacAddressString &)=default
 Default copy-constructor so objects can be passed by value. More...
std::string getString () const
std::string getTruncatedString () const

Static Public Member Functions

static std::unique_ptr< MacAddressStringcreate (const std::string &macAddress)

Detailed Description

A class used to validate a MAC address string before construction.

Constructor & Destructor Documentation

◆ MacAddressString()

alexaClientSDK::avsCommon::utils::MacAddressString::MacAddressString ( const MacAddressString )

Default copy-constructor so objects can be passed by value.

Member Function Documentation

◆ create()

static std::unique_ptr<MacAddressString> alexaClientSDK::avsCommon::utils::MacAddressString::create ( const std::string &  macAddress)

Factory that validates the MAC address before constructing the actual object.

macAddress user supplied MacAddress

nullptr if the input MAC address is illegal, otherwise a unique_ptr to a MacAddressString object that can be used to get the desired string.

◆ getString()

std::string alexaClientSDK::avsCommon::utils::MacAddressString::getString ( ) const

Returns a the MAC address.

The MAC address.

◆ getTruncatedString()

std::string alexaClientSDK::avsCommon::utils::MacAddressString::getTruncatedString ( ) const

Utility function to truncate a valid MAC address. The first 4 octets are X'd out.

The truncated mac address.

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0