client.h File Reference

Client APIs. More...

Detailed Description

Client APIs.

Author

Carl Seifert carl..nosp@m.seif.nosp@m.ert@t.nosp@m.u-dr.nosp@m.esden.nosp@m..de

Definition in file client.h.

#include <stdbool.h>
#include <stdint.h>
#include "xfa.h"
#include "ztimer.h"
#include "event.h"
#include "net/unicoap/constants.h"
#include "net/unicoap/message.h"
#include "net/unicoap/transport.h"
#include "net/unicoap/util_macros.h"

Include dependency graph for client.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	unicoap_request_parameters_t
	Additional parameters to customize request behavior. More...

Customizing request behavior
enum	unicoap_request_flags_t { UNICOAP_REQUEST_FLAG_RELIABLE = 0x0001 }
	Flags for enabling advanced features in client exchanges. More...
void	unicoap_print_request_flags (unicoap_request_flags_t flags)
	Prints request flags.

Sending a request
typedef int(*	unicoap_response_callback_t) (const unicoap_message_t *response, const unicoap_aux_t *aux, int error, void *arg)
	Response or error callback.
int	unicoap_send_request_async (unicoap_message_t *request, unicoap_destination_t *destination, unicoap_response_callback_t callback, unicoap_request_parameters_t *parameters, unicoap_request_flags_t flags)
	Sends a request asynchronously.
int	unicoap_send_request_sync (unicoap_message_t *request, unicoap_destination_t *destination, unicoap_response_callback_t callback, unicoap_request_parameters_t *parameters, unicoap_request_flags_t flags)
	Sends a request synchronously.
int	unicoap_send_request_sync_copy (unicoap_message_t *request, unicoap_destination_t *destination, unicoap_message_t *response, unicoap_request_parameters_t *parameters, unicoap_request_flags_t flags, unicoap_aux_t *aux)
	Sends a request synchronously and copies the request to the given buffer.

Cancelling a request
int	unicoap_cancel_request (int refno)
	Cancels request with reference number.