alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCHandlerRegistrationInterface Class Reference

#include <IPCHandlerRegistrationInterface.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCHandlerRegistrationInterface:

Public Member Functions
virtual	~IPCHandlerRegistrationInterface ()=default
virtual std::shared_ptr< IPCDispatcherInterface >	registerHandler (const std::string &ipcNamespace, std::weak_ptr< IPCHandlerBase > handler)=0
virtual bool	deregisterHandler (const std::string &ipcNamespace)=0

Detailed Description

A contract to register IPC message handler for a given namespace.

Constructor & Destructor Documentation

~IPCHandlerRegistrationInterface()

virtual alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCHandlerRegistrationInterface::~IPCHandlerRegistrationInterface ( )

virtualdefault

Default Destructor.

Member Function Documentation

deregisterHandler()

virtual bool alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCHandlerRegistrationInterface::deregisterHandler ( const std::string &  ipcNamespace )

pure virtual

De-registers a IPC handler interface for a given namespace

Parameters

ipcNamespace

Namespace for the IPC handler to be de-registered.

Returns

true if successful.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCRouter.

registerHandler()

virtual std::shared_ptr<IPCDispatcherInterface> alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCHandlerRegistrationInterface::registerHandler ( const std::string &  ipcNamespace, std::weak_ptr< IPCHandlerBase >  handler  )

pure virtual

Registers a IPC handler interface for a given namespace

Parameters

ipcNamespace	Namespace for the IPC handler to be registered.
handler	A weak pointer to the handler instance.

Returns

an instance of Dispatcher used to sending message over IPC channel.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCRouter.

---

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

• /workplace/avs-device-sdk/SampleApplications/IPCServerSampleApplication/LibIPCServerSampleApp/include/IPCServerSampleApp/IPC/IPCHandlerRegistrationInterface.h