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::network::InternetConnectionMonitor Class Reference

#include <InternetConnectionMonitor.h>

Inheritance diagram for alexaClientSDK::avsCommon::utils::network::InternetConnectionMonitor:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::avsCommon::utils::network::InternetConnectionMonitor:
Collaboration graph
[legend]

Public Member Functions

virtual ~InternetConnectionMonitor ()
 
InternetConnectionMonitorInterface Methods
void addInternetConnectionObserver (std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionObserverInterface > observer) override
 
void removeInternetConnectionObserver (std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionObserverInterface > observer) override
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::InternetConnectionMonitorInterface
virtual void addInternetConnectionObserver (std::shared_ptr< InternetConnectionObserverInterface > observer)=0
 
virtual void removeInternetConnectionObserver (std::shared_ptr< InternetConnectionObserverInterface > observer)=0
 
virtual ~InternetConnectionMonitorInterface ()=default
 

Static Public Member Functions

static std::shared_ptr< sdkInterfaces::InternetConnectionMonitorInterfacecreateInternetConnectionMonitorInterface (const std::shared_ptr< sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface > &contentFetcherFactory)
 
static std::unique_ptr< InternetConnectionMonitorcreate (std::shared_ptr< sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface > contentFetcherFactory)
 

Detailed Description

A class to monitor internet connection and notify observers of connection status changes.

Constructor & Destructor Documentation

◆ ~InternetConnectionMonitor()

virtual alexaClientSDK::avsCommon::utils::network::InternetConnectionMonitor::~InternetConnectionMonitor ( )
virtual

Destructor.

Member Function Documentation

◆ addInternetConnectionObserver()

void alexaClientSDK::avsCommon::utils::network::InternetConnectionMonitor::addInternetConnectionObserver ( std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionObserverInterface observer)
override

◆ create()

static std::unique_ptr<InternetConnectionMonitor> alexaClientSDK::avsCommon::utils::network::InternetConnectionMonitor::create ( std::shared_ptr< sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface contentFetcherFactory)
static

Creates a InternetConnectionMonitor.

Parameters
contentFetcherFactoryThe content fetcher that will make the test run to an S3 endpoint.
Returns
A unique_ptr to the InternetConnectionMonitor instance.

◆ createInternetConnectionMonitorInterface()

static std::shared_ptr<sdkInterfaces::InternetConnectionMonitorInterface> alexaClientSDK::avsCommon::utils::network::InternetConnectionMonitor::createInternetConnectionMonitorInterface ( const std::shared_ptr< sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface > &  contentFetcherFactory)
static

Factory for creating instances of InternetConnectionMonitorInterface.

Parameters
contentFetcherFactoryFactory for creating content fetchers with which to verify connectivity.
Returns
An instance of InternetConnectionMonitor.

◆ removeInternetConnectionObserver()

void alexaClientSDK::avsCommon::utils::network::InternetConnectionMonitor::removeInternetConnectionObserver ( std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionObserverInterface observer)
override

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

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