coap_client.h File Reference

CoAP client API. More...

#include <zephyr/net/coap.h>
#include <zephyr/kernel.h>

Go to the source code of this file.

Data Structures
struct	coap_client_response_data
	Representation for CoAP client response data. More...
struct	coap_client_option
	Representation of extra options for the CoAP client request. More...
struct	coap_client_request
	Representation of a CoAP client request. More...

Macros
#define	MAX_COAP_MSG_LEN
	Maximum size of a CoAP message.

Typedefs
typedef void(*	coap_client_response_cb_t) (const struct coap_client_response_data *data, void *user_data)
	Callback for CoAP request.
typedef int(*	coap_client_payload_cb_t) (size_t offset, const uint8_t **payload, size_t *len, bool *last_block, void *user_data)
	Callback for providing a payload for the CoAP request.

Functions
int	coap_client_init (struct coap_client *client, const char *info)
	Initialize the CoAP client.
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_cancel_requests (struct coap_client *client)
	Cancel all current requests.
void	coap_client_cancel_request (struct coap_client *client, struct coap_client_request *req)
	Cancel matching requests.
struct coap_client_option	coap_client_option_initial_block2 (void)
	Initialise a Block2 option to be added to a request.
bool	coap_client_has_ongoing_exchange (struct coap_client *client)
	Check if client has ongoing exchange.

Detailed Description

CoAP client API.

An API for applications to do CoAP requests