/usr/include/x86_64-linux-gnu/alljoyn/controlpanel/ControlPanelService.h is in liballjoynservices-dev-1604 16.04-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 | /******************************************************************************
* Copyright AllSeen Alliance. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
******************************************************************************/
#ifndef CONTROLPANELSERVICE_H_
#define CONTROLPANELSERVICE_H_
#include <alljoyn/BusAttachment.h>
#include <alljoyn/controlpanel/ControlPanelControllee.h>
#include <alljoyn/controlpanel/ControlPanelController.h>
#include <alljoyn/controlpanel/ControlPanelBusListener.h>
#include <alljoyn/controlpanel/ControlPanelListener.h>
namespace ajn {
namespace services {
/**
* ControlPanel Service class. Used to initialize and shutdown the service
*/
class ControlPanelService {
public:
/**
* Get Instance of ControlPanelServiceImpl - singleton implementation
* @return instance
*/
static ControlPanelService* getInstance();
/**
* Destructor for ControlPanelServiceImpl
*/
~ControlPanelService();
/**
* Initialize the controllee to be used
* @param bus - bus used for Controllee
* @param controlPanelControllee - controllee to initialize
* @return status - success/failure
*/
QStatus initControllee(BusAttachment* bus, ControlPanelControllee* controlPanelControllee);
/**
* Remove locally stored controllee. Allows a new call to initControllee to be made
* @return status - success/failure
*/
QStatus shutdownControllee();
/**
* Initialize the controller to be used
* @param bus - bus used for Controller
* @param controlPanelController - controller to initialize
* @param controlPanelListener
* @return status - success/failure
*/
QStatus initController(BusAttachment* bus, ControlPanelController* controlPanelController,
ControlPanelListener* controlPanelListener);
/**
* Remove locally stored controller. Allows a new call to initController to be made
* @return status - success/failure
*/
QStatus shutdownController();
/**
* Full shutdown - includes removing the current BusAttachment
* @return status - success/failure
*/
QStatus shutdown();
/**
* Method to get the busAttachment used in the service.
* @return BusAttachment
*/
ajn::BusAttachment* getBusAttachment();
/**
* Get the BusListener
* @return ControlPanelBusListener
*/
ControlPanelBusListener* getBusListener() const;
/**
* Get the ControlPanelListener
* @return ControlPanelListener
*/
ControlPanelListener* getControlPanelListener() const;
/**
* Utility function to split an objectPath based on the / delimeter
* @param objectPath
* @return vector of objectPath parts
*/
static std::vector<qcc::String> SplitObjectPath(qcc::String const& objectPath);
/**
* Get the Version of the ControlPanelService
* @return the ControlPanelService version
*/
static uint16_t getVersion();
private:
/**
* Default constructor for ControlPanelServiceImpl
* Private to allow for singleton implementation
*/
ControlPanelService();
/**
* Copy constructor of ControlPanelService - private. ControlPanelService is not copy-able
* @param handler - ControlPanelService to copy
*/
ControlPanelService(const ControlPanelService& handler);
/**
* Assignment operator of ControlPanelService - private. ControlPanelService is not assignable
* @param handler
* @return ControlPanelService
*/
ControlPanelService& operator=(const ControlPanelService& handler);
/**
* Version of the API
*/
static uint16_t const CONTROLPANEL_SERVICE_VERSION;
/**
* Instance variable - ControlPanelServiceImpl is a singleton
*/
static ControlPanelService* s_Instance;
/**
* BusAttachement used in Service
*/
BusAttachment* m_Bus;
/**
* BusListener used in service
*/
ControlPanelBusListener* m_BusListener;
/**
* ControlPanelControllee of service
*/
ControlPanelControllee* m_ControlPanelControllee;
/**
* ControlPanelController of service
*/
ControlPanelController* m_ControlPanelController;
/**
* ControlPanelListener of service
*/
ControlPanelListener* m_ControlPanelListener;
};
} //namespace services
} //namespace ajn
#endif /* CONTROLPANELSERVICE_H_ */
|