AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
Classes | |
class | AB |
class | ABSubclass |
struct | Annotation1 |
Type used to annotate (i.e. distinguish instances of) another type. More... | |
struct | Annotation2 |
Type used to annotate (i.e. distinguish instances of) another type. More... | |
struct | Annotation3 |
Type used to annotate (i.e. distinguish instances of) another type. More... | |
struct | Annotation4 |
Type used to annotate (i.e. distinguish instances of) another type. More... | |
class | Dependency |
class | InterfaceA |
class | InterfaceAB |
class | InterfaceB |
class | ManufactoryTest |
struct | Type1 |
shared_ptr<InterfaceAB> alexaClientSDK::acsdkManufactory::test::createAB | ( | ) |
Factory used to create an instance of InterfaceAB.
Annotated<Annotation1, InterfaceAB> alexaClientSDK::acsdkManufactory::test::createAB1 | ( | const Annotated< Annotation3, InterfaceAB > & | ab3 | ) |
Factory used to create an annotated (with Annotation1) instance of InterfaceAB that depends upon the instance of InterfaceAB annotated with Annotation3.
ab3 | A different instance of InterfaceAB (annotated with Annotation3) |
Annotated<Annotation2, InterfaceAB> alexaClientSDK::acsdkManufactory::test::createAB2 | ( | ) |
Factory used to create an annotated (with Annotation2) instance of InterfaceAB.
Annotated<Annotation3, InterfaceAB> alexaClientSDK::acsdkManufactory::test::createAB3 | ( | const Annotated< Annotation2, InterfaceAB > & | ab2 | ) |
Factory used to create an annotated (with Annotation3) instance of InterfaceAB that depends upon the instance of InterfaceAB annotated with Annotation2.
ab2 | A different instance of InterfaceAB (annotated with Annotation2) |
|
static |
Template function to create instances of a variety of subclasses of AB.
X | A number used to distinguish subclasses. |
shared_ptr<InterfaceA> alexaClientSDK::acsdkManufactory::test::createAFromAB | ( | const shared_ptr< InterfaceAB > & | ab | ) |
Factory for InterfaceA that depends upon an instance of InterfaceAB, and which returns an InterfaceA pointer the the provided instance of InterfaceAB.
ab | The instance of InterfaceAB to use to create an InterfaceA. |
shared_ptr<InterfaceB> alexaClientSDK::acsdkManufactory::test::createBFromAB | ( | const shared_ptr< InterfaceAB > & | ab | ) |
Factory for InterfaceB that depends upon an instance of InterfaceAB, and which returns an InterfaceB pointer the the provided instance of InterfaceAB.
ab | The instance of InterfaceAB to use to create an InterfaceB. |
shared_ptr<InterfaceA> alexaClientSDK::acsdkManufactory::test::createCyclicA | ( | const shared_ptr< InterfaceB > & | ) |
Factory for instances of InterfaceA that depends upon InterfaceB.
shared_ptr<InterfaceB> alexaClientSDK::acsdkManufactory::test::createCyclicB | ( | const shared_ptr< InterfaceA > & | ) |
Factory for instances of InterfaceB that depends upon InterfaceA.
Annotated<Annotation2, InterfaceAB> alexaClientSDK::acsdkManufactory::test::createRequiredAB2 | ( | const Annotated< Annotation1, InterfaceAB > & | ab1 | ) |
Factory for an instance of InterfaceAB annotated with Anotation2, which is dependent upon an instance of InterfaceAB annotated with Annotation1.
ab1 | An instance of InterfaceAB annotated with Annotation1. |
Annotated<Annotation1, InterfaceAB> alexaClientSDK::acsdkManufactory::test::createRetainedAB1 | ( | ) |
Factory for an instance of InterfaceAB annotated with Anotation1.
shared_ptr<InterfaceAB> alexaClientSDK::acsdkManufactory::test::createSharedAB | ( | ) |
Factory for creating a new instance of InterfaceAB and returning it via shared_ptr<InterfaceAB>.
unique_ptr<InterfaceA> alexaClientSDK::acsdkManufactory::test::createUniqueA | ( | ) |
Factory for creating a new instance of InterfaceA and returning it via unique_ptr<InterfaceA>.
Component<shared_ptr<InterfaceA>, shared_ptr<InterfaceB> > alexaClientSDK::acsdkManufactory::test::getABComponent | ( | ) |
Definition of a component that exports implementations of InterfaceA and InterfaceB.
Component< Annotated<Annotation1, AB>, Annotated<Annotation2, AB>, Annotated<Annotation3, AB>, Annotated<Annotation4, AB>, Annotated<Annotation2, AB> > alexaClientSDK::acsdkManufactory::test::getAnnotatedFunctionTestComponent | ( | ) |
Component< Annotated<Annotation1, InterfaceAB>, Annotated<Annotation2, InterfaceAB>, Import<Annotated<Annotation3, InterfaceAB> > > alexaClientSDK::acsdkManufactory::test::getComponent12 | ( | ) |
Definition of a component that exports instances of InterfaceAB annotated with Annotation1 and Annotation2, and which imports an instance of InterfaceAB annotated with Annotation3.
Component<Annotated<Annotation3, InterfaceAB> > alexaClientSDK::acsdkManufactory::test::getComponent3 | ( | ) |
Definition of a component that exports the instance of InterfaceAB annotated with Annotation3.
Component<shared_ptr<InterfaceA>, shared_ptr<InterfaceB> > alexaClientSDK::acsdkManufactory::test::getCyclicComponent | ( | ) |
Definition of a component with a cyclic dependency graph (InterfaceA <-> InterfaceB).
function<shared_ptr<ABSubclass<X> >Dependencies...)> alexaClientSDK::acsdkManufactory::test::getFunctionFactory | ( | ) |
Component<shared_ptr<ABSubclass<1> >, shared_ptr<ABSubclass<2> >, shared_ptr<ABSubclass<3> >, shared_ptr<ABSubclass<4> > > alexaClientSDK::acsdkManufactory::test::getFunctionTestComponent | ( | ) |
Component<shared_ptr<Type1>, OptionalImport<shared_ptr<Dependency> > > alexaClientSDK::acsdkManufactory::test::getOptional | ( | ) |
Component<shared_ptr<ABSubclass<1> >, shared_ptr<ABSubclass<2> >, shared_ptr<ABSubclass<3> > > alexaClientSDK::acsdkManufactory::test::getPrimaryTestComponent | ( | ) |
Definition of a component that includes both primary and required types to verify proper ordering of their instantiation.
Component<Annotated<Annotation1, InterfaceAB> > alexaClientSDK::acsdkManufactory::test::getRequiredComponent | ( | ) |
Definition of a Component that exports a 'required' instance of InterfaceAB annotated with Annotation1.
Component<shared_ptr<InterfaceAB> > alexaClientSDK::acsdkManufactory::test::getRetainedABComponent | ( | ) |
Definition of a Component that exports 'retained' (not unloadable) instances of InterfaceAB.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_manufactureUnique | |||
) |
Test manufacture of an instances returned via unique_ptr. Verify that multiple instances of the same interface are indeed distinct instances.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_manufactureShared | |||
) |
Test manufacture of an 'unloadable' instance returned via shared_ptr. Verify that while an instance is still referenced, manufacture of the same interface will provide the same instance. Also verify that when all references have been deleted, the next manufacture will create a new instance.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_multipleInhertance | |||
) |
Verify that a single object can be manufactured as multiple interfaces.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_annotatedManufacture | |||
) |
Verify that annotations can be used to distinguish specific instances of objects. Also verify that imports between components are properly resolved.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_retainedManufacture | |||
) |
Verify that manufacture of retained interfaces provides a single instance fore the life of the manufactory.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_requiredManufacture | |||
) |
Verify that manufacture of a required interface results in instantiation of the interface at the time that the Manufactory
is created rather than being driven by other dependencies.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_primeManufacture | |||
) |
Verify that primary factories are invoked before required factories.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_functionManufacture | |||
) |
Verify that function factories work and are invoked in the correct order.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_anotatedFunctionManufacture | |||
) |
Verify that function factories work and are invoked in the correct order.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_checkCyclicDependencies | |||
) |
Verify that circular dependencies are detected, and the creation of an Manufactory from a component with a circular dependency will fail.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_subManufactory | |||
) |
Verify that the creation of a subManufactory works and that cached instances are shared between the primary and subManufactorys.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_missingOptionalImportUsesEmptyObject | |||
) |
Test that we are able to build manufactory from a component that has unsatisfied Optional dependency. Expect manufactory to just wire nullptr to that dependency.
alexaClientSDK::acsdkManufactory::test::TEST_F | ( | ManufactoryTest | , |
test_withOptionalImportUsesProvidedImplementation | |||
) |
Test that if the user provides a recipe for an optional dependency, the recipe is used.
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0