sol-lwm2m-client.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * 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.
 */
#pragma once

#include "sol-lwm2m.h"

#ifdef __cplusplus
extern "C" {
#endif

struct sol_lwm2m_client;
typedef struct sol_lwm2m_client sol_lwm2m_client;

enum sol_lwm2m_bootstrap_event {
    SOL_LWM2M_BOOTSTRAP_EVENT_FINISHED,
    SOL_LWM2M_BOOTSTRAP_EVENT_ERROR
};

typedef struct sol_lwm2m_object {
#ifndef SOL_NO_API_VERSION
#define SOL_LWM2M_OBJECT_API_VERSION (1)

    uint16_t api_version;
#endif

    uint16_t id;

    /* @brief The number of resources that the object has */
    uint16_t resources_count;

    int (*create)(void *user_data, struct sol_lwm2m_client *client,
        uint16_t instance_id, void **instance_data, struct sol_lwm2m_payload payload);
    int (*read)(void *instance_data, void *user_data,
        struct sol_lwm2m_client *client, uint16_t instance_id,
        uint16_t res_id, struct sol_lwm2m_resource *res);
    int (*write_resource)(void *instance_data, void *user_data,
        struct sol_lwm2m_client *client, uint16_t instance_id, uint16_t res_id,
        const struct sol_lwm2m_resource *res);
    int (*write_tlv)(void *instance_data, void *user_data,
        struct sol_lwm2m_client *client, uint16_t instance_id,
        struct sol_vector *tlvs);
    int (*execute)(void *instance_data, void *user_data,
        struct sol_lwm2m_client *client, uint16_t instance_id,
        uint16_t res_id, const struct sol_str_slice args);

    int (*del)(void *instance_data, void *user_data,
        struct sol_lwm2m_client *client, uint16_t instance_id);
} sol_lwm2m_object;

struct sol_lwm2m_client *sol_lwm2m_client_new(const char *name,
    const char *path, const char *sms, const struct sol_lwm2m_object **objects,
    const void *data);

void sol_lwm2m_client_del(struct sol_lwm2m_client *client);

int sol_lwm2m_client_add_object_instance(struct sol_lwm2m_client *client,
    const struct sol_lwm2m_object *obj, const void *data);

int sol_lwm2m_client_start(struct sol_lwm2m_client *client);

int sol_lwm2m_client_stop(struct sol_lwm2m_client *client);

int sol_lwm2m_client_send_update(struct sol_lwm2m_client *client);

int sol_lwm2m_client_notify(struct sol_lwm2m_client *client, const char **paths);

int sol_lwm2m_client_add_bootstrap_finish_monitor(struct sol_lwm2m_client *client,
    void (*sol_lwm2m_client_bootstrap_event_cb)(void *data,
    struct sol_lwm2m_client *client,
    enum sol_lwm2m_bootstrap_event event),
    const void *data);

int sol_lwm2m_client_del_bootstrap_finish_monitor(struct sol_lwm2m_client *client,
    void (*sol_lwm2m_client_bootstrap_event_cb)(void *data,
    struct sol_lwm2m_client *client,
    enum sol_lwm2m_bootstrap_event event),
    const void *data);

#ifdef __cplusplus
}
#endif