Revision control
++ // Copyright (C) 2016 The Qt Company Ltd.
++ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
++
++ #include "qlowenergyadvertisingparameters.h"
++
++ QT_BEGIN_NAMESPACE
++
++ class QLowEnergyAdvertisingParametersPrivate : public QSharedData
++ {
++ public:
++ QLowEnergyAdvertisingParametersPrivate()
++ : filterPolicy(QLowEnergyAdvertisingParameters::IgnoreWhiteList)
++ , mode(QLowEnergyAdvertisingParameters::AdvInd)
++ , minInterval(1280)
++ , maxInterval(1280)
++ {
++ }
++
++ QList<QLowEnergyAdvertisingParameters::AddressInfo> whiteList;
++ QLowEnergyAdvertisingParameters::FilterPolicy filterPolicy;
++ QLowEnergyAdvertisingParameters::Mode mode;
++ int minInterval;
++ int maxInterval;
++ };
++
++ /*!
++ \since 5.7
++ \class QLowEnergyAdvertisingParameters
++ \brief The QLowEnergyAdvertisingParameters class represents the parameters used for
++ Bluetooth Low Energy advertising.
++ \inmodule QtBluetooth
++ \ingroup shared
++
++ When running the advertising procedure, a number of parameters can be configured, such as
++ how fast to advertise or which clients, if any, can connect to the advertising device.
++ These parameters are set via this class, and their values will be used when advertising
++ is started by calling \l QLowEnergyController::startAdvertising().
++
++ \sa QLowEnergyAdvertisingData
++ \sa QLowEnergyController::startAdvertising()
++ */
++
++ /*!
++ \enum QLowEnergyAdvertisingParameters::Mode
++
++ Specifies in which way to advertise.
++ \value AdvInd
++ For non-directed, connectable advertising. Advertising is not directed to
++ one specific device and a device seeing the advertisement can connect to the
++ advertising device or send scan requests.
++ \value AdvScanInd
++ For non-directed, scannable advertising. Advertising is not directed to
++ one specific device and a device seeing the advertisement can send a scan
++ request to the advertising device, but cannot connect to it.
++ \value AdvNonConnInd
++ For non-directed, non-connectable advertising. Advertising is not directed to
++ one specific device. A device seeing the advertisement cannot connect to the
++ advertising device, nor can it send a scan request. This mode thus implies
++ pure broadcasting.
++ */
++
++ /*!
++ \enum QLowEnergyAdvertisingParameters::FilterPolicy
++
++ Specifies the semantics of the white list.
++ \value IgnoreWhiteList
++ The value of the white list is ignored, that is, no filtering takes place for
++ either scan or connection requests when using undirected advertising.
++ \value UseWhiteListForScanning
++ The white list is used when handling scan requests, but is ignored for connection
++ requests.
++ \value UseWhiteListForConnecting
++ The white list is used when handling connection requests, but is ignored for scan
++ requests.
++ \value UseWhiteListForScanningAndConnecting
++ The white list is used for both connection and scan requests.
++
++ \sa QLowEnergyAdvertisingParameters::whiteList()
++ */
++
++ /*!
++ \class QLowEnergyAdvertisingParameters::AddressInfo
++ \inmodule QtBluetooth
++ \since 5.7
++
++ \brief The QLowEnergyAdvertisingParameters::AddressInfo defines the elements of a white list.
++
++ A list of QLowEnergyAdvertisingParameters::AddressInfo instances is passed to
++ \l QLowEnergyAdvertisingParameters::setWhiteList(). White lists are used to
++ restrict the devices which have the permission to interact with the peripheral.
++ The permitted type of interaction is defined by
++ \l QLowEnergyAdvertisingParameters::FilterPolicy.
++
++ \sa QLowEnergyAdvertisingParameters::whiteList()
++ */
++
++ /*!
++ \variable QLowEnergyAdvertisingParameters::AddressInfo::address
++
++ This is the Bluetooth address of a remote device.
++ */
++
++ /*!
++ \variable QLowEnergyAdvertisingParameters::AddressInfo::type
++
++ The type of the address (public or private).
++ The \l AddressInfo default constructor initialises this value to
++ \l QLowEnergyController::PublicAddress.
++ */
++
++ /*!
++ \fn QLowEnergyAdvertisingParameters::AddressInfo::AddressInfo(const QBluetoothAddress &addr, QLowEnergyController::RemoteAddressType type)
++
++ Constructs a new AddressInfo instance. \a addr represents the Bluetooth address of
++ the remote device and \a type the nature of the address.
++ */
++
++ /*!
++ \fn QLowEnergyAdvertisingParameters::AddressInfo::AddressInfo()
++
++ Constructs a default constructed AddressInfo instance.
++
++ By default the \l AddressInfo::type member is set to
++ \l QLowEnergyController::PublicAddress and the \l AddressInfo::address
++ member has a null address.
++ */
++
++ /*!
++ Constructs a new object of this class. All values are initialized to their defaults
++ according to the Bluetooth Low Energy specification.
++ */
++ QLowEnergyAdvertisingParameters::QLowEnergyAdvertisingParameters()
++ : d(new QLowEnergyAdvertisingParametersPrivate)
++ {
++ }
++
++ /*! Constructs a new object of this class that is a copy of \a other. */
++ QLowEnergyAdvertisingParameters::QLowEnergyAdvertisingParameters(const QLowEnergyAdvertisingParameters &other)
++ : d(other.d)
++ {
++ }
++
++ /*! Destroys this object. */
++ QLowEnergyAdvertisingParameters::~QLowEnergyAdvertisingParameters()
++ {
++ }
++
++ /*! Makes this object a copy of \a other and returns the new value of this object. */
++ QLowEnergyAdvertisingParameters &QLowEnergyAdvertisingParameters::operator=(const QLowEnergyAdvertisingParameters &other)
++ {
++ d = other.d;
++ return *this;
++ }
++
++ /*! Sets the advertising mode to \a mode. */
++ void QLowEnergyAdvertisingParameters::setMode(QLowEnergyAdvertisingParameters::Mode mode)
++ {
++ d->mode = mode;
++ }
++
++ /*!
++ Returns the advertising mode. The default is \l QLowEnergyAdvertisingParameters::AdvInd.
++ */
++ QLowEnergyAdvertisingParameters::Mode QLowEnergyAdvertisingParameters::mode() const
++ {
++ return d->mode;
++ }
++
++ /*!
++ Sets the white list that is potentially used for filtering scan and connection requests.
++ The \a whiteList parameter is the list of addresses to use for filtering, and \a policy
++ specifies how exactly to use \a whiteList.
++
++ Whitelists are not supported on the BlueZ DBus backend as they are not supported by BlueZ.
++ */
++ void QLowEnergyAdvertisingParameters::setWhiteList(const QList<AddressInfo> &whiteList,
++ FilterPolicy policy)
++ {
++ d->whiteList = whiteList;
++ d->filterPolicy = policy;
++ }
++
++ /*!
++ Returns the white list used for filtering scan and connection requests.
++ By default, this list is empty.
++ */
++ QList<QLowEnergyAdvertisingParameters::AddressInfo> QLowEnergyAdvertisingParameters::whiteList() const
++ {
++ return d->whiteList;
++ }
++
++ /*!
++ Returns the filter policy that determines how the white list is used. The default
++ is \l QLowEnergyAdvertisingParameters::IgnoreWhiteList.
++ */
++ QLowEnergyAdvertisingParameters::FilterPolicy QLowEnergyAdvertisingParameters::filterPolicy() const
++ {
++ return d->filterPolicy;
++ }
++
++ /*!
++ Sets the advertising interval. This is a range that gives the controller an upper and a lower
++ bound for how often to send the advertising data. Both \a minimum and \a maximum are given
++ in milliseconds.
++ If \a maximum is smaller than \a minimum, it will be set to the value of \a minimum.
++ \note There are limits for the minimum and maximum interval; the exact values depend on
++ the mode. If they are exceeded, the lowest or highest possible value will be used,
++ respectively.
++
++ Setting the advertising interval is supported on BlueZ DBus backend if its experimental
++ status is changed in later versions of BlueZ (or run in experimental mode).
++
++ */
++ void QLowEnergyAdvertisingParameters::setInterval(quint16 minimum, quint16 maximum)
++ {
++ d->minInterval = minimum;
++ d->maxInterval = qMax(minimum, maximum);
++ }
++
++ /*!
++ Returns the minimum advertising interval in milliseconds. The default is 1280.
++ */
++ int QLowEnergyAdvertisingParameters::minimumInterval() const
++ {
++ return d->minInterval;
++ }
++
++ /*!
++ Returns the maximum advertising interval in milliseconds. The default is 1280.
++ */
++ int QLowEnergyAdvertisingParameters::maximumInterval() const
++ {
++ return d->maxInterval;
++ }
++
++ /*!
++ \fn void QLowEnergyAdvertisingParameters::swap(QLowEnergyAdvertisingParameters &other)
++ Swaps this object with \a other.
++ */
++
++ /*!
++ \brief Returns \c true if \a a and \a b are equal with respect to their public state,
++ otherwise returns \c false.
++ \internal
++ */
++ bool QLowEnergyAdvertisingParameters::equals(const QLowEnergyAdvertisingParameters &a,
++ const QLowEnergyAdvertisingParameters &b)
++ {
++ if (a.d == b.d)
++ return true;
++ return a.filterPolicy() == b.filterPolicy() && a.minimumInterval() == b.minimumInterval()
++ && a.maximumInterval() == b.maximumInterval() && a.mode() == b.mode()
++ && a.whiteList() == b.whiteList();
++ }
++
++ bool QLowEnergyAdvertisingParameters::AddressInfo::equals(
++ const QLowEnergyAdvertisingParameters::AddressInfo &ai1,
++ const QLowEnergyAdvertisingParameters::AddressInfo &ai2)
++ {
++ return ai1.address == ai2.address && ai1.type == ai2.type;
++ }
++
++ /*!
++ \fn bool QLowEnergyAdvertisingParameters::operator!=(
++ const QLowEnergyAdvertisingParameters &a,
++ const QLowEnergyAdvertisingParameters &b)
++ \brief Returns \c true if \a a and \a b are not equal with respect to their public state,
++ otherwise returns \c false.
++ */
++
++ /*!
++ \fn bool QLowEnergyAdvertisingParameters::operator==(
++ const QLowEnergyAdvertisingParameters &a,
++ const QLowEnergyAdvertisingParameters &b)
++ \brief Returns \c true if \a a and \a b are equal with respect to their public state,
++ otherwise returns \c false.
++ */
++
++ /*!
++ \fn bool QLowEnergyAdvertisingParameters::AddressInfo::operator!=(const
++ QLowEnergyAdvertisingParameters::AddressInfo &a, const
++ QLowEnergyAdvertisingParameters::AddressInfo &b)
++
++ \brief Returns \c true if \a a and \a b are not equal with respect to their public state,
++ otherwise returns \c false.
++ */
++
++ /*!
++ \fn bool QLowEnergyAdvertisingParameters::AddressInfo::operator==(
++ const QLowEnergyAdvertisingParameters::AddressInfo &a,
++ const QLowEnergyAdvertisingParameters::AddressInfo &b)
++ \brief Returns \c true if \a a and \a b are equal with respect to their public state,
++ otherwise returns \c false.
++ */
++
++ QT_END_NAMESPACE