Zephyr API Documentation 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
coap_client.h
Go to the documentation of this file.
1
6
7/*
8 * Copyright (c) 2023 Nordic Semiconductor ASA
9 *
10 * SPDX-License-Identifier: Apache-2.0
11 */
12#ifndef ZEPHYR_INCLUDE_NET_COAP_CLIENT_H_
13#define ZEPHYR_INCLUDE_NET_COAP_CLIENT_H_
14
23
24#include <zephyr/net/coap.h>
25#include <zephyr/kernel.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
32#define MAX_COAP_MSG_LEN (CONFIG_COAP_CLIENT_MESSAGE_HEADER_SIZE + \
33 CONFIG_COAP_CLIENT_MESSAGE_SIZE)
34
55
68typedef void (*coap_client_response_cb_t)(const struct coap_client_response_data *data,
69 void *user_data);
70
86
93#if defined(CONFIG_COAP_EXTENDED_OPTIONS_LEN)
97 uint8_t value[CONFIG_COAP_EXTENDED_OPTIONS_LEN_VALUE];
98#else
103#endif
104};
105
107struct coap_client_internal_request {
108 uint8_t request_token[COAP_TOKEN_MAX_LEN];
109 uint32_t offset;
110 uint16_t last_id;
111 uint8_t request_tkl;
112 bool request_ongoing;
113 atomic_t in_callback;
114 struct coap_block_context recv_blk_ctx;
115 struct coap_block_context send_blk_ctx;
116 struct coap_pending pending;
117 struct coap_client_request coap_request;
118 struct coap_packet request;
119 uint8_t request_tag[COAP_TOKEN_MAX_LEN];
120
121 /* For GETs with observe option set */
122 bool is_observe;
123 int last_response_id;
124};
125
126struct coap_client {
127 int fd;
128 struct sockaddr address;
129 socklen_t socklen;
130 struct k_mutex lock;
131 uint8_t send_buf[MAX_COAP_MSG_LEN];
132 uint8_t recv_buf[MAX_COAP_MSG_LEN];
133 struct coap_client_internal_request requests[CONFIG_COAP_CLIENT_MAX_REQUESTS];
134 struct coap_option echo_option;
135 bool send_echo;
136};
138
148int coap_client_init(struct coap_client *client, const char *info);
149
166
167int coap_client_req(struct coap_client *client, int sock, const struct sockaddr *addr,
168 struct coap_client_request *req, struct coap_transmission_parameters *params);
169
180void coap_client_cancel_requests(struct coap_client *client);
181
195void coap_client_cancel_request(struct coap_client *client, struct coap_client_request *req);
196
209
225bool coap_client_has_ongoing_exchange(struct coap_client *client);
226
227#ifdef __cplusplus
228}
229#endif
230
234
235#endif /* ZEPHYR_INCLUDE_NET_COAP_CLIENT_H_ */
long atomic_t
Definition atomic_types.h:15
CoAP implementation for Zephyr.
int coap_client_req(struct coap_client *client, int sock, const struct sockaddr *addr, struct coap_client_request *req, struct coap_transmission_parameters *params)
Send CoAP request.
void(* coap_client_response_cb_t)(const struct coap_client_response_data *data, void *user_data)
Callback for CoAP request.
Definition coap_client.h:68
void coap_client_cancel_requests(struct coap_client *client)
Cancel all current requests.
struct coap_client_option coap_client_option_initial_block2(void)
Initialise a Block2 option to be added to a request.
#define MAX_COAP_MSG_LEN
Maximum size of a CoAP message.
Definition coap_client.h:32
void coap_client_cancel_request(struct coap_client *client, struct coap_client_request *req)
Cancel matching requests.
bool coap_client_has_ongoing_exchange(struct coap_client *client)
Check if client has ongoing exchange.
int coap_client_init(struct coap_client *client, const char *info)
Initialize the CoAP client.
coap_method
Available request methods.
Definition coap.h:76
coap_content_format
Set of Content-Format option values for CoAP.
Definition coap.h:214
uint32_t socklen_t
Length of a socket address.
Definition net_ip.h:172
Public kernel APIs.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
__INT16_TYPE__ int16_t
Definition stdint.h:73
Represents the current state of a block-wise transaction.
Definition coap.h:789
Representation of extra options for the CoAP client request.
Definition coap_client.h:90
uint16_t code
Option code.
Definition coap_client.h:92
uint8_t value[12]
Buffer for the length.
Definition coap_client.h:102
uint8_t len
Option len.
Definition coap_client.h:100
Representation of a CoAP client request.
Definition coap_client.h:74
uint8_t num_options
Number of extra options.
Definition coap_client.h:83
size_t len
Length of the payload.
Definition coap_client.h:80
enum coap_method method
Method of the request.
Definition coap_client.h:75
bool confirmable
CoAP Confirmable/Non-confirmable message.
Definition coap_client.h:76
const char * path
Path of the requested resource.
Definition coap_client.h:77
const struct coap_client_option * options
Extra options to be added to request.
Definition coap_client.h:82
const uint8_t * payload
User allocated buffer for send request.
Definition coap_client.h:79
void * user_data
User provided context.
Definition coap_client.h:84
enum coap_content_format fmt
Content format to be used.
Definition coap_client.h:78
coap_client_response_cb_t cb
Callback when response received.
Definition coap_client.h:81
Representation for CoAP client response data.
Definition coap_client.h:38
const uint8_t * payload
Buffer containing the payload from the response.
Definition coap_client.h:49
int16_t result_code
Result code of the response.
Definition coap_client.h:43
const struct coap_packet * packet
A pointer to the response CoAP packet.
Definition coap_client.h:45
bool last_block
Indicates the last block of the response.
Definition coap_client.h:53
size_t payload_len
Size of the payload.
Definition coap_client.h:51
size_t offset
Payload offset from the beginning of a blockwise transfer.
Definition coap_client.h:47
Representation of a CoAP Packet.
Definition coap.h:312
Represents a request awaiting for an acknowledgment (ACK).
Definition coap.h:376
CoAP transmission parameters.
Definition coap.h:357
Generic sockaddr struct.
Definition net_ip.h:410