sol-oic-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 <stdbool.h>
#include <stdint.h>
#include <sol-coap.h>
#include <sol-network.h>
#include <sol-str-slice.h>
#include <sol-vector.h>

#ifdef __cplusplus
extern "C" {
#endif

#include "sol-oic.h"

struct sol_oic_client;
typedef struct sol_oic_client sol_oic_client;

struct sol_oic_pending;
typedef struct sol_oic_pending sol_oic_pending;

typedef struct sol_oic_resource {
#ifndef SOL_NO_API_VERSION
#define SOL_OIC_RESOURCE_API_VERSION (1)
    uint16_t api_version; 
#endif

    const struct sol_network_link_addr addr;
    const struct sol_str_slice path;
    const struct sol_str_slice device_id;
    const struct sol_vector types;
    const struct sol_vector interfaces;
    const bool observable;
    const bool secure;
} sol_oic_resource;

struct sol_oic_client *sol_oic_client_new(void);

void sol_oic_client_del(struct sol_oic_client *client);

void sol_oic_pending_cancel(struct sol_oic_pending *pending);

struct sol_oic_pending *sol_oic_client_find_resources(struct sol_oic_client *client,
    struct sol_network_link_addr *addr, const char *resource_type,
    const char *resource_interface,
    bool (*resource_found_cb)(void *data, struct sol_oic_client *cli,
    struct sol_oic_resource *res),
    const void *data);

struct sol_oic_pending *sol_oic_client_get_platform_info(struct sol_oic_client *client,
    struct sol_oic_resource *resource,
    void (*info_received_cb)(void *data, struct sol_oic_client *cli,
    const struct sol_oic_platform_info *info),
    const void *data);

struct sol_oic_pending *sol_oic_client_get_platform_info_by_addr(struct sol_oic_client *client,
    struct sol_network_link_addr *addr,
    void (*info_received_cb)(void *data, struct sol_oic_client *cli,
    const struct sol_oic_platform_info *info),
    const void *data);

struct sol_oic_pending *sol_oic_client_get_server_info(struct sol_oic_client *client,
    struct sol_oic_resource *resource,
    void (*info_received_cb)(void *data, struct sol_oic_client *cli,
    const struct sol_oic_device_info *info),
    const void *data);

struct sol_oic_pending *sol_oic_client_get_server_info_by_addr(struct sol_oic_client *client,
    struct sol_network_link_addr *addr,
    void (*info_received_cb)(void *data, struct sol_oic_client *cli,
    const struct sol_oic_device_info *info),
    const void *data);

struct sol_oic_pending *sol_oic_client_request(struct sol_oic_client *client,
    struct sol_oic_request *request,
    void (*callback)(void *data, enum sol_coap_response_code response_code,
    struct sol_oic_client *cli, const struct sol_network_link_addr *addr,
    const struct sol_oic_map_reader *repr_vec), const void *callback_data);

struct sol_oic_request *sol_oic_client_request_new(enum sol_coap_method method, struct sol_oic_resource *res);

struct sol_oic_request *sol_oic_client_non_confirmable_request_new(enum sol_coap_method method, struct sol_oic_resource *res);

void sol_oic_client_request_free(struct sol_oic_request *request);

struct sol_oic_map_writer *sol_oic_client_request_get_writer(struct sol_oic_request *request);

int sol_oic_client_resource_set_observable(struct sol_oic_client *client, struct sol_oic_resource *res,
    void (*callback)(void *data, enum sol_coap_response_code response_code, struct sol_oic_client *cli, const struct sol_network_link_addr *addr,
    const struct sol_oic_map_reader *repr_map),
    const void *data, bool observe);

int sol_oic_client_resource_set_observable_non_confirmable(struct sol_oic_client *client, struct sol_oic_resource *res,
    void (*callback)(void *data, enum sol_coap_response_code response_code, struct sol_oic_client *cli, const struct sol_network_link_addr *addr,
    const struct sol_oic_map_reader *repr_map),
    const void *data, bool observe);

struct sol_oic_resource *sol_oic_resource_ref(struct sol_oic_resource *r);

void sol_oic_resource_unref(struct sol_oic_resource *r);

#ifdef __cplusplus
}
#endif