AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Protected Member Functions | List of all members
alexaClientSDK::bluetoothImplementations::blueZ::DBusObjectBase Class Reference

#include <DBusObjectBase.h>

Inheritance diagram for alexaClientSDK::bluetoothImplementations::blueZ::DBusObjectBase:
Inheritance graph
[legend]

Public Member Functions

virtual ~DBusObjectBase ()
 
bool registerWithDBus ()
 
void unregisterObject ()
 

Protected Member Functions

 DBusObjectBase (std::shared_ptr< DBusConnection > connection, const std::string &xmlInterfaceIntrospection, const std::string &objectPath, GDBusInterfaceMethodCallFunc methodCallFunc)
 
void onMethodCalledInternal (const char *methodName)
 

Detailed Description

Base class for objects exposed to DBus

Constructor & Destructor Documentation

◆ ~DBusObjectBase()

virtual alexaClientSDK::bluetoothImplementations::blueZ::DBusObjectBase::~DBusObjectBase ( )
virtual

Destructor

◆ DBusObjectBase()

alexaClientSDK::bluetoothImplementations::blueZ::DBusObjectBase::DBusObjectBase ( std::shared_ptr< DBusConnection connection,
const std::string &  xmlInterfaceIntrospection,
const std::string &  objectPath,
GDBusInterfaceMethodCallFunc  methodCallFunc 
)
protected

A constructor.

Parameters
connectionDBusConnection connection to register this object with
xmlInterfaceIntrospectionXML containing the description of the interfaces this object implements. See objectPath Path to register the object to methodCallFunc GDBusInterfaceMethodCallFunc callback that handles the incoming method calls

Member Function Documentation

◆ onMethodCalledInternal()

void alexaClientSDK::bluetoothImplementations::blueZ::DBusObjectBase::onMethodCalledInternal ( const char *  methodName)
protected

Method used solely for logging the call of the object's method

Parameters
methodNamethe called method name

◆ registerWithDBus()

bool alexaClientSDK::bluetoothImplementations::blueZ::DBusObjectBase::registerWithDBus ( )

Registers an object with DBus

Returns
true if succeeded, false otherwise

◆ unregisterObject()

void alexaClientSDK::bluetoothImplementations::blueZ::DBusObjectBase::unregisterObject ( )

Unregisters the object from DBus


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