BluetoothGattCharacteristic.hpp

/*
 * Author: Petre Eftime <petre.p.eftime@intel.com>
 * Copyright (c) 2015 Intel Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once
#include "BluetoothObject.hpp"
#include "BluetoothManager.hpp"
#include "BluetoothGattDescriptor.hpp"
#include <string>
#include <vector>
#include <functional>

/* Forward declaration of types */
struct _Object;
typedef struct _Object Object;
struct _GattCharacteristic1;
typedef struct _GattCharacteristic1 GattCharacteristic1;


class tinyb::BluetoothGattCharacteristic: public BluetoothObject
{

friend class tinyb::BluetoothGattService;
friend class tinyb::BluetoothGattDescriptor;
friend class tinyb::BluetoothManager;
friend class tinyb::BluetoothEventManager;
friend class BluetoothNotificationHandler;

private:
    GattCharacteristic1 *object;

protected:
    BluetoothGattCharacteristic(GattCharacteristic1 *object);

    static std::unique_ptr<BluetoothGattCharacteristic> make(Object *object,
        BluetoothType type = BluetoothType::GATT_CHARACTERISTIC,
        std::string *name = nullptr,
        std::string *identifier = nullptr,
        BluetoothObject *parent = nullptr);

    std::function<void(std::vector<unsigned char> &)> value_changed_callback;

    bool start_notify ();
    bool stop_notify ();

public:

    static std::string java_class() {
        return std::string(JAVA_PACKAGE "/BluetoothGattCharacteristic");
    }
    static BluetoothType class_type() { return BluetoothType::GATT_CHARACTERISTIC; }

    virtual std::string get_java_class() const;
    virtual std::string get_class_name() const ;
    virtual std::string get_object_path() const;
    virtual BluetoothType get_bluetooth_type() const;

    BluetoothGattCharacteristic(const BluetoothGattCharacteristic &object);
    ~BluetoothGattCharacteristic();
    virtual BluetoothGattCharacteristic *clone() const;

    std::unique_ptr<BluetoothGattDescriptor> find(
        std::string *identifier,
        std::chrono::milliseconds timeout = std::chrono::milliseconds::zero())
    {

        BluetoothManager *manager = BluetoothManager::get_bluetooth_manager();
        return manager->find<BluetoothGattDescriptor>(nullptr, identifier, this, timeout);
    }

    /* D-Bus method calls: */
    std::vector<unsigned char> read_value (
        uint16_t offset = 0
    );

    bool write_value (const std::vector<unsigned char> &arg_value, uint16_t offset = 0);

    bool enable_value_notifications(
        std::function<void(BluetoothGattCharacteristic &characteristic, std::vector<unsigned char> &value,void *userdata)> callback,
        void *user_data);
    bool enable_value_notifications(
        std::function<void(std::vector<unsigned char> &value)> callback);
    bool disable_value_notifications();

    /* D-Bus property accessors: */
    std::string get_uuid ();

    BluetoothGattService get_service ();

    std::vector<unsigned char> get_value ();

    bool get_notifying ();

    std::vector<std::string> get_flags ();

    std::vector<std::unique_ptr<BluetoothGattDescriptor>> get_descriptors ();

};