sol-coap.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-socket.h>
#include <sol-network.h>
#include <sol-str-slice.h>

#ifdef __cplusplus
extern "C" {
#endif

enum sol_coap_option {
    SOL_COAP_OPTION_IF_MATCH = 1,
    SOL_COAP_OPTION_URI_HOST = 3,
    SOL_COAP_OPTION_ETAG = 4,
    SOL_COAP_OPTION_IF_NONE_MATCH = 5,
    SOL_COAP_OPTION_OBSERVE = 6,
    SOL_COAP_OPTION_URI_PORT = 7,
    SOL_COAP_OPTION_LOCATION_PATH = 8,
    SOL_COAP_OPTION_URI_PATH = 11,
    SOL_COAP_OPTION_CONTENT_FORMAT = 12,
    SOL_COAP_OPTION_MAX_AGE = 14,
    SOL_COAP_OPTION_URI_QUERY = 15,
    SOL_COAP_OPTION_ACCEPT = 17,
    SOL_COAP_OPTION_LOCATION_QUERY = 20,
    SOL_COAP_OPTION_PROXY_URI = 35,
    SOL_COAP_OPTION_PROXY_SCHEME = 39
};

enum sol_coap_method {
    SOL_COAP_METHOD_GET = 1,
    SOL_COAP_METHOD_POST = 2,
    SOL_COAP_METHOD_PUT = 3,
    SOL_COAP_METHOD_DELETE = 4,
};

#define SOL_COAP_REQUEST_MASK 0x07

enum sol_coap_message_type {
    SOL_COAP_MESSAGE_TYPE_CON = 0,
    SOL_COAP_MESSAGE_TYPE_NON_CON = 1,
    SOL_COAP_MESSAGE_TYPE_ACK = 2,
    SOL_COAP_MESSAGE_TYPE_RESET = 3
};

#define sol_coap_make_response_code(clas, det) ((clas << 5) | (det))

enum sol_coap_response_code {
    SOL_COAP_RESPONSE_CODE_OK = sol_coap_make_response_code(2, 0),
    SOL_COAP_RESPONSE_CODE_CREATED = sol_coap_make_response_code(2, 1),
    SOL_COAP_RESPONSE_CODE_DELETED = sol_coap_make_response_code(2, 2),
    SOL_COAP_RESPONSE_CODE_VALID = sol_coap_make_response_code(2, 3),
    SOL_COAP_RESPONSE_CODE_CHANGED = sol_coap_make_response_code(2, 4),
    SOL_COAP_RESPONSE_CODE_CONTENT = sol_coap_make_response_code(2, 5),
    SOL_COAP_RESPONSE_CODE_BAD_REQUEST = sol_coap_make_response_code(4, 0),
    SOL_COAP_RESPONSE_CODE_UNAUTHORIZED = sol_coap_make_response_code(4, 1),
    SOL_COAP_RESPONSE_CODE_BAD_OPTION = sol_coap_make_response_code(4, 2),
    SOL_COAP_RESPONSE_CODE_FORBIDDEN = sol_coap_make_response_code(4, 3),
    SOL_COAP_RESPONSE_CODE_NOT_FOUND = sol_coap_make_response_code(4, 4),
    SOL_COAP_RESPONSE_CODE_NOT_ALLOWED = sol_coap_make_response_code(4, 5),
    SOL_COAP_RESPONSE_CODE_NOT_ACCEPTABLE = sol_coap_make_response_code(4, 6),
    SOL_COAP_RESPONSE_CODE_PRECONDITION_FAILED = sol_coap_make_response_code(4, 12),
    SOL_COAP_RESPONSE_CODE_REQUEST_TOO_LARGE = sol_coap_make_response_code(4, 13),
    SOL_COAP_RESPONSE_CODE_UNSUPPORTED_CONTENT_FORMAT = sol_coap_make_response_code(4, 15),
    SOL_COAP_RESPONSE_CODE_INTERNAL_ERROR = sol_coap_make_response_code(5, 0),
    SOL_COAP_RESPONSE_CODE_NOT_IMPLEMENTED = sol_coap_make_response_code(5, 1),
    SOL_COAP_RESPONSE_CODE_BAD_GATEWAY = sol_coap_make_response_code(5, 2),
    SOL_COAP_RESPONSE_CODE_SERVICE_UNAVAILABLE = sol_coap_make_response_code(5, 3),
    SOL_COAP_RESPONSE_CODE_GATEWAY_TIMEOUT = sol_coap_make_response_code(5, 4),
    SOL_COAP_RESPONSE_CODE_PROXYING_NOT_SUPPORTED = sol_coap_make_response_code(5, 5)
};

#define SOL_COAP_CODE_EMPTY (0)

enum sol_coap_content_type {
    SOL_COAP_CONTENT_TYPE_NONE = -1,
    SOL_COAP_CONTENT_TYPE_TEXT_PLAIN = 0,
    SOL_COAP_CONTENT_TYPE_APPLICATION_LINK_FORMAT = 40,
    SOL_COAP_CONTENT_TYPE_APPLICATION_CBOR = 60, /* RFC7049 */
    SOL_COAP_CONTENT_TYPE_APPLICATION_JSON = 50,
};

enum sol_coap_flags {
    SOL_COAP_FLAGS_NONE       = 0,
    SOL_COAP_FLAGS_WELL_KNOWN = (1 << 1)
};

struct sol_coap_packet;
typedef struct sol_coap_packet sol_coap_packet;

struct sol_coap_server;
typedef struct sol_coap_server sol_coap_server;

typedef struct sol_coap_resource {
#ifndef SOL_NO_API_VERSION
#define SOL_COAP_RESOURCE_API_VERSION (1)

    uint16_t api_version;
#endif

    int (*get)(void *data, struct sol_coap_server *server,
        const struct sol_coap_resource *resource,
        struct sol_coap_packet *req,
        const struct sol_network_link_addr *cliaddr);
    int (*post)(void *data, struct sol_coap_server *server,
        const struct sol_coap_resource *resource,
        struct sol_coap_packet *req,
        const struct sol_network_link_addr *cliaddr);
    int (*put)(void *data, struct sol_coap_server *server,
        const struct sol_coap_resource *resource,
        struct sol_coap_packet *req,
        const struct sol_network_link_addr *cliaddr);
    int (*del)(void *data, struct sol_coap_server *server,
        const struct sol_coap_resource *resource,
        struct sol_coap_packet *req,
        const struct sol_network_link_addr *cliaddr);
    enum sol_coap_flags flags;
    struct sol_str_slice path[];
} sol_coap_resource;

int sol_coap_header_get_version(const struct sol_coap_packet *pkt, uint8_t *version);

int sol_coap_header_get_type(const struct sol_coap_packet *pkt, uint8_t *type);

uint8_t *sol_coap_header_get_token(const struct sol_coap_packet *pkt, uint8_t *len);

int sol_coap_header_get_code(const struct sol_coap_packet *pkt, uint8_t *code);

int sol_coap_header_get_id(const struct sol_coap_packet *pkt, uint16_t *id);

int sol_coap_header_set_version(struct sol_coap_packet *pkt, uint8_t ver);

int sol_coap_header_set_type(struct sol_coap_packet *pkt, uint8_t type);

int sol_coap_header_set_token(struct sol_coap_packet *pkt, uint8_t *token, uint8_t tokenlen);

int sol_coap_header_set_code(struct sol_coap_packet *pkt, uint8_t code);

int sol_coap_header_set_id(struct sol_coap_packet *pkt, uint16_t id);

bool sol_coap_server_is_secure(const struct sol_coap_server *server);

struct sol_coap_server *sol_coap_server_new(const struct sol_network_link_addr *addr, bool secure);

struct sol_coap_server *sol_coap_server_new_by_cipher_suites(
    const struct sol_network_link_addr *addr,
    enum sol_socket_dtls_cipher *cipher_suites,
    uint16_t cipher_suites_len);

struct sol_coap_server *sol_coap_server_ref(struct sol_coap_server *server);

void sol_coap_server_unref(struct sol_coap_server *server);

struct sol_coap_packet *sol_coap_packet_new(struct sol_coap_packet *old);

struct sol_coap_packet *sol_coap_packet_new_request(enum sol_coap_method method, enum sol_coap_message_type type);

struct sol_coap_packet *sol_coap_packet_new_notification(struct sol_coap_server *server,
    struct sol_coap_resource *resource);

struct sol_coap_packet *sol_coap_packet_ref(struct sol_coap_packet *pkt);

void sol_coap_packet_unref(struct sol_coap_packet *pkt);

int sol_coap_packet_get_payload(struct sol_coap_packet *pkt, struct sol_buffer **buf, size_t *offset);

bool sol_coap_packet_has_payload(struct sol_coap_packet *pkt);

int sol_coap_add_option(struct sol_coap_packet *pkt, uint16_t code, const void *value, uint16_t len);

int sol_coap_packet_add_uri_path_option(struct sol_coap_packet *pkt, const char *uri);

const void *sol_coap_find_first_option(const struct sol_coap_packet *pkt, uint16_t code, uint16_t *len);

int sol_coap_find_options(const struct sol_coap_packet *pkt, uint16_t code, struct sol_str_slice *vec, uint16_t veclen);

int sol_coap_send_packet(struct sol_coap_server *server, struct sol_coap_packet *pkt,
    const struct sol_network_link_addr *cliaddr);

int sol_coap_send_packet_with_reply(struct sol_coap_server *server, struct sol_coap_packet *pkt,
    const struct sol_network_link_addr *cliaddr,
    bool (*reply_cb)(void *data, struct sol_coap_server *server,
    struct sol_coap_packet *req, const struct sol_network_link_addr *cliaddr), const void *data);

int sol_coap_notify(struct sol_coap_server *server,
    struct sol_coap_resource *resource, struct sol_coap_packet *pkt);

int sol_coap_notify_by_callback(struct sol_coap_server *server,
    struct sol_coap_resource *resource,
    int (*cb)(void *cb_data, struct sol_coap_server *server,
    struct sol_coap_resource *resource, struct sol_network_link_addr *addr,
    struct sol_coap_packet **pkt),
    const void *cb_data);

int sol_coap_server_register_resource(struct sol_coap_server *server,
    const struct sol_coap_resource *resource, const void *data);

int sol_coap_server_unregister_resource(struct sol_coap_server *server,
    const struct sol_coap_resource *resource);

int sol_coap_path_to_buffer(const struct sol_str_slice path[],
    struct sol_buffer *buf, size_t offset, size_t *size);

int sol_coap_cancel_send_packet(struct sol_coap_server *server, struct sol_coap_packet *pkt, struct sol_network_link_addr *cliaddr);

int sol_coap_unobserve_by_token(struct sol_coap_server *server, const struct sol_network_link_addr *cliaddr, uint8_t *token, uint8_t tkl);


int sol_coap_server_set_unknown_resource_handler(struct sol_coap_server *server,
    int (*handler)(void *data, struct sol_coap_server *server,
    struct sol_coap_packet *req, const struct sol_network_link_addr *cliaddr),
    const void *data);

#ifdef SOL_LOG_ENABLED
void sol_coap_packet_debug(struct sol_coap_packet *pkt);
#else
static inline void
sol_coap_packet_debug(struct sol_coap_packet *pkt)
{
}
#endif


#ifdef __cplusplus
}
#endif