pt_api.h

Go to the documentation of this file.

/*
 * ----------------------------------------------------------------------------
 * Copyright 2018 ARM Ltd.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ----------------------------------------------------------------------------
 */

#ifndef PT_API_VERSION
#define PT_API_VERSION 1
#endif
#if PT_API_VERSION != 1
#error "Including mixed versions of Protocol API"
#endif

#ifndef PT_API_H_
#define PT_API_H_

#ifdef __GNUC__
#define DEPRECATED(func) func __attribute__((deprecated))
#else
#pragma message("WARNING: Implement DEPRECATED macro, it is missing.")
#define DEPRECATED(func) func
#endif

#include "ns_list.h"

#include "common/constants.h"
#include "common/default_message_id_generator.h"
#include "edge-rpc/rpc.h"

typedef struct pt_resource pt_resource_t;
typedef struct pt_resource pt_resource_opaque_t;
typedef struct pt_object_instance pt_object_instance_t;
typedef struct pt_object pt_object_t;
typedef struct pt_device pt_device_t;

DEPRECATED(
    typedef void (*pt_resource_callback)(const pt_resource_t *resource,
                                         const uint8_t *value,
                                         const uint32_t size,
                                         void *userdata));

DEPRECATED(typedef void (*pt_connection_ready_cb)(struct connection *connection, void *userdata));

DEPRECATED(typedef void (*pt_disconnected_cb)(struct connection *connection, void *userdata));

DEPRECATED(typedef void (*pt_connection_shutdown_cb)(struct connection **connection, void *userdata));

DEPRECATED(
    typedef int (*pt_received_write_handler)(struct connection *connection,
                                             const char *device_id, const uint16_t object_id,
                                             const uint16_t instance_id,
                                             const uint16_t resource_id,
                                             const unsigned int operation,
                                             const uint8_t *value, const uint32_t value_size,
                                             void *userdata));

typedef enum {
    NONE,
    QUEUE
} queuemode_t;

typedef enum {
    PT_STATUS_SUCCESS = 0,
    PT_STATUS_ERROR,
    PT_STATUS_ITEM_EXISTS,
    PT_STATUS_INVALID_PARAMETERS,
    PT_STATUS_ALLOCATION_FAIL,
    PT_STATUS_NOT_CONNECTED
} pt_status_t;

typedef struct pt_resource {
    ns_list_link_t link;
    pt_object_instance_t *parent;
    Lwm2mResourceType type;
    uint16_t id;
    unsigned int operations;
    uint8_t *value;
    uint32_t value_size;
    pt_resource_callback callback;
} pt_resource_t;

typedef NS_LIST_HEAD(pt_resource_t, link) pt_resource_list_t;

typedef struct pt_object_instance {
    ns_list_link_t link;
    pt_object_t *parent;
    pt_resource_list_t *resources;
    uint16_t id;
} pt_object_instance_t;

typedef NS_LIST_HEAD(pt_object_instance_t, link) pt_object_instance_list_t;

typedef struct pt_object {
    ns_list_link_t link;
    pt_device_t *parent;
    pt_object_instance_list_t *instances;
    uint16_t id;
} pt_object_t;

typedef NS_LIST_HEAD(pt_object_t, link) pt_object_list_t;

struct pt_device_userdata_s;

typedef void (*pt_device_free_userdata_cb_t)(void *data);

typedef struct pt_device_userdata_s {
    void *data; 
    pt_device_free_userdata_cb_t
            pt_device_free_userdata; 
} pt_device_userdata_t;

typedef struct pt_device {
    ns_list_link_t link;
    char* device_id;
    uint32_t lifetime;
    queuemode_t queuemode;
    pt_device_userdata_t *userdata;
    pt_object_list_t *objects;
} pt_device_t;

typedef struct client_data_s {
    char* name;
    bool registered;
    int id;
    void* method_table;
} client_data_t;

typedef struct protocol_translator_callbacks {
    pt_connection_ready_cb connection_ready_cb;
    pt_disconnected_cb disconnected_cb;
    pt_received_write_handler received_write_cb; 
    pt_connection_shutdown_cb connection_shutdown_cb;
} protocol_translator_callbacks_t;

typedef struct connection connection_t;

DEPRECATED(typedef void (*pt_response_handler)(void* userdata));

DEPRECATED(typedef void (*pt_device_response_handler)(const char* device_id, void* userdata));

DEPRECATED(
    pt_status_t pt_register_protocol_translator(connection_t *connection,
                                                pt_response_handler success_handler,
                                                pt_response_handler failure_handler,
                                                void* userdata));

DEPRECATED(
    pt_status_t pt_register_device(connection_t *connection,
                                   pt_device_t *device,
                                   pt_device_response_handler success_handler,
                                   pt_device_response_handler failure_handler,
                                   void *userdata));

DEPRECATED(
    pt_status_t pt_unregister_device(connection_t *connection,
                                     pt_device_t *device,
                                     pt_device_response_handler success_handler,
                                     pt_device_response_handler failure_handler,
                                     void *userdata));

DEPRECATED(pt_device_userdata_t *pt_api_create_device_userdata(void *data,
                                                               pt_device_free_userdata_cb_t free_userdata_cb));

DEPRECATED(
    pt_device_t *pt_create_device_with_userdata(char *device_id,
                                                const uint32_t lifetime,
                                                const queuemode_t queuemode,
                                                pt_status_t *status,
                                                pt_device_userdata_t *userdata));

DEPRECATED(
    pt_device_t *pt_create_device(char *device_id,
                                  const uint32_t lifetime,
                                  const queuemode_t queuemode,
                                  pt_status_t *status));

DEPRECATED(void pt_device_free(pt_device_t *device));

DEPRECATED(pt_object_t *pt_device_add_object(pt_device_t *device, uint16_t id, pt_status_t *status));

DEPRECATED(pt_object_t *pt_device_find_object(pt_device_t *device, uint16_t id));

DEPRECATED(pt_object_instance_t * pt_object_add_object_instance(pt_object_t *object, uint16_t id, pt_status_t *status));

DEPRECATED(pt_object_instance_t *pt_object_find_object_instance(pt_object_t *object, uint16_t id));

DEPRECATED(
    pt_resource_t *pt_object_instance_add_resource(pt_object_instance_t *object_instance,
                                                   uint16_t id,
                                                   Lwm2mResourceType type,
                                                   uint8_t *value,
                                                   uint32_t value_size,
                                                   pt_status_t *status));

DEPRECATED(
    pt_resource_t *pt_object_instance_add_resource_with_callback(pt_object_instance_t *object_instance,
                                                                 uint16_t id,
                                                                 Lwm2mResourceType type,
                                                                 uint8_t operations,
                                                                 uint8_t *value,
                                                                 uint32_t value_size,
                                                                 pt_status_t *status,
                                                                 pt_resource_callback callback));

DEPRECATED(pt_resource_t *pt_object_instance_find_resource(pt_object_instance_t *instance, uint16_t id));

DEPRECATED(
    pt_status_t pt_write_value(connection_t *connection,
                               pt_device_t *device,
                               pt_object_list_t *objects,
                               pt_device_response_handler success_handler,
                               pt_device_response_handler failure_handler,
                               void *userdata));

DEPRECATED(int pt_receive_write_value(json_t *request, json_t *json_params, json_t **result, void *userdata));

DEPRECATED(
    int pt_client_start(const char *socket_path,
                        const char *name,
                        const protocol_translator_callbacks_t *pt_cbs,
                        void *userdata,
                        connection_t **connection));

DEPRECATED(void pt_client_shutdown(connection_t *connection));

#endif /* PT_API_H_ */