alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface Class Reference

#include <EndpointRegistrationManagerInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface:

Public Types
using	RegistrationResult = EndpointRegistrationObserverInterface::RegistrationResult
	Aliases. More...
using	DeregistrationResult = EndpointRegistrationObserverInterface::DeregistrationResult
using	UpdateResult = EndpointRegistrationObserverInterface::UpdateResult

Public Member Functions
virtual	~EndpointRegistrationManagerInterface ()=default
virtual std::future< RegistrationResult >	registerEndpoint (std::shared_ptr< EndpointInterface > endpoint)=0
virtual std::future< UpdateResult >	updateEndpoint (const EndpointIdentifier &endpointId, const std::shared_ptr< EndpointModificationData > &endpointModificationData)=0
virtual std::future< DeregistrationResult >	deregisterEndpoint (const EndpointIdentifier &endpointId)=0
virtual void	addObserver (std::shared_ptr< EndpointRegistrationObserverInterface > observer)=0
virtual void	removeObserver (const std::shared_ptr< EndpointRegistrationObserverInterface > &observer)=0

Detailed Description

Class responsible for managing endpoints handled by this client. This includes:

• Registering the endpoint and its capabilities with AVS (via CapabilitiesDelegateInterface).
• Registering endpoint's directive handlers with DirectiveSequencerInterface.
• Ensuring endpointId uniqueness across endpoints controlled by this device.

Member Typedef Documentation

DeregistrationResult

using alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::DeregistrationResult = EndpointRegistrationObserverInterface::DeregistrationResult

RegistrationResult

using alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::RegistrationResult = EndpointRegistrationObserverInterface::RegistrationResult

Aliases.

UpdateResult

using alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::UpdateResult = EndpointRegistrationObserverInterface::UpdateResult

Constructor & Destructor Documentation

~EndpointRegistrationManagerInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::~EndpointRegistrationManagerInterface ( )

virtualdefault

Destructor

Member Function Documentation

addObserver()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::addObserver ( std::shared_ptr< EndpointRegistrationObserverInterface >  observer )

pure virtual

Adds a registration manager observer to be notified when a registration has succeeded.

Parameters

observer

The observer to add.

Implemented in alexaClientSDK::endpoints::EndpointRegistrationManager.

deregisterEndpoint()

virtual std::future<DeregistrationResult> alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::deregisterEndpoint ( const EndpointIdentifier &  endpointId )

pure virtual

Deregisters an endpoint.

Parameters

endpoint

The EndpointIdentifier of the endpoint to be deregistered.

Returns

A future that is set to true when the endpoint has been deregistered, or that is set to false if the operation failed.

Note

This operation is asynchronous. You can also use EndpointRegistrationObserverInterface to get notified whenever the operation succeeds or fails.

Implemented in alexaClientSDK::endpoints::EndpointRegistrationManager.

registerEndpoint()

virtual std::future<RegistrationResult> alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::registerEndpoint ( std::shared_ptr< EndpointInterface >  endpoint )

pure virtual

Registers an endpoint.

Note

endpointIds are unique. An endpoint is not allowed to be registered with an existing endpointId.

Parameters

endpoint

A pointer to the EndpointInterface to be registered.

Returns

A future that is set to true when the endpoint has been registered and enabled, or that is set to false if the operation failed.

Note

This operation is asynchronous. You can also use EndpointRegistrationObserverInterface to get notified whenever the operation succeeds or fails.

Implemented in alexaClientSDK::endpoints::EndpointRegistrationManager.

removeObserver()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::removeObserver ( const std::shared_ptr< EndpointRegistrationObserverInterface > &  observer )

pure virtual

Remove a previously registered observer.

Parameters

observer

The observer to be removed.

Implemented in alexaClientSDK::endpoints::EndpointRegistrationManager.

updateEndpoint()

virtual std::future<UpdateResult> alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::updateEndpoint ( const EndpointIdentifier &  endpointId, const std::shared_ptr< EndpointModificationData > &  endpointModificationData  )

pure virtual

Update an existing endpoint.

Parameters

endpointId	The EndpointIdentifier of the endpoint to be updated.
endpointModificationData	A pointer to the EndpointModificationData used to update the endpoint.

Returns

A future that is set to true when the endpoint has been updated, or that is set to false if the operation failed.

Note

This operation is asynchronous. You can also use EndpointRegistrationObserverInterface to get notified whenever the operation succeeds or fails.

Warning

If the default endpoint fails to update due to the invalid endpointModificationData, the desync of capabilities between AVS and the device would happen. Applications should treat failure to update the default endpoint as a critical error.

Implemented in alexaClientSDK::endpoints::EndpointRegistrationManager.

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/Endpoints/EndpointRegistrationManagerInterface.h