alexaClientSDK::acsdkCommunicationInterfaces::CommunicationInvokeHandlerInterface< ReturnType, ArgTypes > Class Template Reference

#include <CommunicationInvokeHandlerInterface.h>

Public Member Functions
virtual	~CommunicationInvokeHandlerInterface ()=default
virtual bool	registerFunction (const std::string &name, std::shared_ptr< FunctionInvokerInterface< ReturnType, ArgTypes... >> functionImplementation)=0
virtual alexaClientSDK::avsCommon::utils::error::SuccessResult< ReturnType >	invoke (const std::string &name, ArgTypes...)=0
virtual bool	deregister (const std::string &name, const std::shared_ptr< FunctionInvokerInterface< ReturnType, ArgTypes... >> &functionImplementation)=0

Detailed Description

template<typename ReturnType, typename... ArgTypes>
class alexaClientSDK::acsdkCommunicationInterfaces::CommunicationInvokeHandlerInterface< ReturnType, ArgTypes >

The CommunicationInvokeHandlerInterface is used to register, deregister, and invoke functions from another component with only a link to the CommunicationInvokeHandler. The implementation of this interface is not responsible for keeping FunctionInvokerInterface implementations alive.

Constructor & Destructor Documentation

~CommunicationInvokeHandlerInterface()

template<typename ReturnType, typename... ArgTypes>

virtual alexaClientSDK::acsdkCommunicationInterfaces::CommunicationInvokeHandlerInterface< ReturnType, ArgTypes >::~CommunicationInvokeHandlerInterface ( )

virtualdefault

Virtual destructor to assure proper cleanup of derived types.

Member Function Documentation

deregister()

template<typename ReturnType, typename... ArgTypes>

virtual bool alexaClientSDK::acsdkCommunicationInterfaces::CommunicationInvokeHandlerInterface< ReturnType, ArgTypes >::deregister ( const std::string &  name, const std::shared_ptr< FunctionInvokerInterface< ReturnType, ArgTypes... >> &  functionImplementation  )

pure virtual

Deregister the function

Parameters

name	The name of the function to deregister
functionImplementation	The function that we are deregistering. Used for confirmation of ownership.

Returns

true if deregister succeeds, false otherwise

invoke()

template<typename ReturnType, typename... ArgTypes>

virtual alexaClientSDK::avsCommon::utils::error::SuccessResult<ReturnType> alexaClientSDK::acsdkCommunicationInterfaces::CommunicationInvokeHandlerInterface< ReturnType, ArgTypes >::invoke ( const std::string &  name, ArgTypes...    )

pure virtual

Invokes the registered function specified by the name. If the function isn't registered or the function has expired nothing will be invoked.

Parameters

name	The name of the function
Args	The args that will be passed to the function.

Returns

SuccessResult<ReturnType> if the callback succeeds or not. If successful the return value.

registerFunction()

template<typename ReturnType, typename... ArgTypes>

virtual bool alexaClientSDK::acsdkCommunicationInterfaces::CommunicationInvokeHandlerInterface< ReturnType, ArgTypes >::registerFunction ( const std::string &  name, std::shared_ptr< FunctionInvokerInterface< ReturnType, ArgTypes... >>  functionImplementation  )

pure virtual

Register a new function that other components can trigger with the CommunicationInvokeHandlerInterface

Parameters

name	The name of the function.
functionImplementation	The class that implements functionToBeInvoked

Returns

true if succeeds, false otherwise

---

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

• /workplace/avs-device-sdk/shared/acsdkCommunicationInterfaces/include/acsdkCommunicationInterfaces/CommunicationInvokeHandlerInterface.h