/usr/include/x86_64-linux-gnu/alljoyn/AboutProxy.h is in liballjoyn-dev-1604 16.04a-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 | /**
* @file
* This contains the AboutProxy class
*/
/******************************************************************************
* 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 _ALLJOYN_ABOUTPROXY_H_
#define _ALLJOYN_ABOUTPROXY_H_
#include <alljoyn/AboutObjectDescription.h>
#include <alljoyn/AboutData.h>
#include <alljoyn/BusAttachment.h>
namespace ajn {
/**
* AboutProxy give proxy access to the org.alljoyn.About interface AboutProxy
* class enables the user to interact with the remote About BusObject instance
* exposing the following methods:
* - GetObjectDescriptions
* - GetAboutData
* - GetVersion
*
*/
class AboutProxy : public ProxyBusObject {
public:
/**
* AboutProxy Constructor
*
* @param bus reference to BusAttachment
* @param[in] busName Unique or well-known name of remote AllJoyn bus
* @param[in] sessionId the session received after joining AllJoyn session
*/
AboutProxy(BusAttachment& bus, const char* busName, SessionId sessionId = 0);
/**
* Destruct AboutProxy
*/
virtual ~AboutProxy();
/**
* Get the ObjectDescription array for the specified bus name.
*
* @param[out] objectDesc Description of busName's remote objects.
*
* @return
* - ER_OK if successful.
* - ER_BUS_REPLY_IS_ERROR_MESSAGE on unknown failure.
*/
QStatus GetObjectDescription(MsgArg& objectDesc);
/**
* Get the AboutData for the specified bus name for a requested language.
* The language tag will be matched against a set of supported languages
* by the remote object using the algorithm specified in RFC 4647
* section 3.4 to find the best matching language or use the default
* language if no match exists. This algorithm requires that the
* "supported" languages be the least specific they can (e.g., "en" in
* order to match both "en" and "en-US" if requested), and the "requested"
* language be the most specific it can (e.g., "en-US" in order to match
* either "en-US" or "en" if supported).
*
* @param[in] languageTag The requested language.
* @param[out] data Reference of AboutData that is filled by the function.
*
* @return
* - ER_OK if successful.
* - ER_BUS_REPLY_IS_ERROR_MESSAGE on unknown failure.
*/
QStatus GetAboutData(const char* languageTag, MsgArg& data);
/**
* GetVersion get the About version
*
* @param[out] version of the service.
*
* @return ER_OK on success
*/
QStatus GetVersion(uint16_t& version);
};
}
#endif /* _ALLJOYN_ABOUTPROXY_H_ */
|