coap_client.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_NET_COAP_CLIENT_H_
#define ZEPHYR_INCLUDE_NET_COAP_CLIENT_H_

 
#include <zephyr/net/coap.h>
#include <zephyr/kernel.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define MAX_COAP_MSG_LEN (CONFIG_COAP_CLIENT_MESSAGE_HEADER_SIZE + \
                          CONFIG_COAP_CLIENT_MESSAGE_SIZE)

#define MAX_COAP_CLIENT_OPTION_LEN (12)

struct coap_client_response_data {
        int16_t result_code;
        const struct coap_packet *packet;
        size_t offset;
        const uint8_t *payload;
        size_t payload_len;
        bool last_block;
#if defined(CONFIG_COAP_CLIENT_MULTICAST) || defined(__DOXYGEN__)
        const struct net_sockaddr *source;

        net_socklen_t source_len;
#endif
};

typedef void (*coap_client_response_cb_t)(const struct coap_client_response_data *data,
                                          void *user_data);

typedef int (*coap_client_payload_cb_t)(size_t offset, const uint8_t **payload,
                                        size_t *len, bool *last_block,
                                        void *user_data);

struct coap_client_option {
        uint16_t code;
#if defined(CONFIG_COAP_EXTENDED_OPTIONS_LEN)
        uint16_t len;
        uint8_t value[CONFIG_COAP_EXTENDED_OPTIONS_LEN_VALUE];
#else
        uint8_t len;
        uint8_t value[MAX_COAP_CLIENT_OPTION_LEN];
#endif
};

#define MAX_PATH_SIZE (CONFIG_COAP_CLIENT_MAX_PATH_LENGTH + 1)
#define MAX_EXTRA_OPTIONS CONFIG_COAP_CLIENT_MAX_EXTRA_OPTIONS

struct coap_client_request {
        enum coap_method method;                  
        bool confirmable;                         
        char path[MAX_PATH_SIZE];                 
        enum coap_content_format fmt;             
        const uint8_t *payload;                   
        size_t len;                               
        coap_client_payload_cb_t payload_cb;      
        coap_client_response_cb_t cb;             
        struct coap_client_option
                options[MAX_EXTRA_OPTIONS];       
        uint8_t num_options;                      
        void *user_data;                          
#if defined(CONFIG_COAP_CLIENT_MULTICAST) || defined(__DOXYGEN__)
        uint32_t multicast_timeout_ms;
#endif
};

struct coap_client_internal_request {
        struct net_sockaddr_storage addr;
        net_socklen_t addrlen;
 
        uint8_t request_token[COAP_TOKEN_MAX_LEN];
        uint32_t offset;
        uint16_t last_id;
        uint8_t request_tkl;
        bool request_ongoing;
        atomic_t in_callback;
        struct coap_block_context recv_blk_ctx;
        struct coap_block_context send_blk_ctx;
        struct coap_pending pending;
        struct coap_client_request coap_request;
        struct coap_packet request;
        uint8_t request_tag[COAP_TOKEN_MAX_LEN];
        uint8_t send_buf[MAX_COAP_MSG_LEN];
 
        /* For GETs with observe option set */
        bool is_observe;
        int last_response_id;
#if defined(CONFIG_COAP_CLIENT_MULTICAST)
        bool is_mcast;
        k_timepoint_t mcast_timeout;
#endif
};

struct coap_client {
        int fd;
        struct k_mutex lock;
        uint8_t recv_buf[MAX_COAP_MSG_LEN];
        struct coap_client_internal_request requests[CONFIG_COAP_CLIENT_MAX_REQUESTS];
        struct coap_option echo_option;
        bool send_echo;
};

int coap_client_init(struct coap_client *client, const char *info);

 
int coap_client_req(struct coap_client *client, int sock, const struct net_sockaddr *addr,
                    struct coap_client_request *req, struct coap_transmission_parameters *params);

void coap_client_cancel_requests(struct coap_client *client);

void coap_client_cancel_request(struct coap_client *client, struct coap_client_request *req);

struct coap_client_option coap_client_option_initial_block2(void);

bool coap_client_has_ongoing_exchange(struct coap_client *client);
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_NET_COAP_CLIENT_H_ */