AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acsdkCommunicationInterfaces::FunctionInvokerInterface< ReturnType, Types > Class Template Referenceabstract

#include <FunctionInvokerInterface.h>

Public Member Functions

virtual ~FunctionInvokerInterface ()=default
 
virtual ReturnType functionToBeInvoked (const std::string &name, Types... args)=0
 

Detailed Description

template<typename ReturnType, typename... Types>
class alexaClientSDK::acsdkCommunicationInterfaces::FunctionInvokerInterface< ReturnType, Types >

The interface for the functions that can be invoked by external components. The implementation of the interface will need to be registered with CommunicationInvokeHandlerInterface. This interface the first template type will be the return type and the rest will be the arguments for the function.

Constructor & Destructor Documentation

◆ ~FunctionInvokerInterface()

template<typename ReturnType, typename... Types>
virtual alexaClientSDK::acsdkCommunicationInterfaces::FunctionInvokerInterface< ReturnType, Types >::~FunctionInvokerInterface ( )
virtualdefault

default destructor

Member Function Documentation

◆ functionToBeInvoked()

template<typename ReturnType, typename... Types>
virtual ReturnType alexaClientSDK::acsdkCommunicationInterfaces::FunctionInvokerInterface< ReturnType, Types >::functionToBeInvoked ( const std::string &  name,
Types...  args 
)
pure virtual

The function or functions that will be registered and invoked by external components. We will specify different functions by using the name param.

Parameters
namethe name of the function we want to invoke.
argsvariadic args that are passed as arguments to the function.
Returns
ReturnType the result of the function.

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