RDK Documentation (Open Sourced RDK Components)
ThunderAccessAAMP Class Reference

Support Thunder Plugin Access from AAMP. More...

#include <ThunderAccess.h>

Collaboration diagram for ThunderAccessAAMP:
Collaboration graph

Public Member Functions

 ThunderAccessAAMP (std::string callsign, AampLogManager *logObj=NULL)
 ThunderAccessAAMP constructor.
 
 ~ThunderAccessAAMP ()
 ThunderAccessAAMP destructor. More...
 
 ThunderAccessAAMP (const ThunderAccessAAMP &)=delete
 ThunderAccessAAMP copy constructor disabled.
 
ThunderAccessAAMPoperator= (const ThunderAccessAAMP &)=delete
 ThunderAccessAAMP assignment disabled.
 
bool ActivatePlugin ()
 ActivatePlugin. More...
 
bool InvokeJSONRPC (std::string method, const JsonObject &param, JsonObject &result, const uint32_t waitTime=5000)
 invokeJSONRPC More...
 
bool SubscribeEvent (string eventName, std::function< void(const WPEFramework::Core::JSON::VariantContainer &)> functionHandler)
 subscribeEvent More...
 
bool UnSubscribeEvent (string eventName)
 unSubscribeEvent More...
 

Private Attributes

JSONRPC::LinkType< Core::JSON::IElement > * remoteObject
 
JSONRPC::LinkType< Core::JSON::IElement > * controllerObject
 
std::string pluginCallsign
 
AampLogManagermLogObj
 

yes

Support Thunder Plugin Access from AAMP.

Definition at line 41 of file ThunderAccess.h.

Constructor & Destructor Documentation

◆ ~ThunderAccessAAMP()

ThunderAccessAAMP::~ThunderAccessAAMP ( )

ThunderAccessAAMP destructor.

Note
clean up

Definition at line 111 of file ThunderAccess.cpp.

Member Function Documentation

◆ ActivatePlugin()

bool ThunderAccessAAMP::ActivatePlugin ( )

ActivatePlugin.

Note
Plugin activation and Remote object creation
Parameters
PluginCallsign
Return values
trueon success
falseon failure

Definition at line 120 of file ThunderAccess.cpp.

◆ InvokeJSONRPC()

ThunderAccessAAMP::InvokeJSONRPC ( std::string  method,
const JsonObject &  param,
JsonObject &  result,
const uint32_t  waitTime = 5000 
)

invokeJSONRPC

Note
Invoke JSONRPC call for the plugin
Invoke JSONRPC call for the plugin
Parameters
method,param,result,method,waitTimereference to input param, result and waitTime (default = THUNDER_RPC_TIMEOUT)
Return values
trueon success
falseon failure

Definition at line 196 of file ThunderAccess.cpp.

◆ SubscribeEvent()

ThunderAccessAAMP::SubscribeEvent ( string  eventName,
std::function< void(const WPEFramework::Core::JSON::VariantContainer &)>  functionHandler 
)

subscribeEvent

Note
Subscribe event data for the specific plugin
Parameters
eventName,functionHandlerEvent name, Event handler
Return values
trueon success
falseon failure

Definition at line 153 of file ThunderAccess.cpp.

◆ UnSubscribeEvent()

ThunderAccessAAMP::UnSubscribeEvent ( string  eventName)

unSubscribeEvent

Note
unSubscribe event data for the specific plugin
Parameters
eventNameEvent name
Return values
trueon success
falseon failure

Definition at line 178 of file ThunderAccess.cpp.

Field Documentation

◆ remoteObject

JSONRPC::LinkType<Core::JSON::IElement>* ThunderAccessAAMP::remoteObject
private

< The Remote object connected to specific Plugin The Remote object connected to controller Plugin

Definition at line 104 of file ThunderAccess.h.


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