client.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2024-2026 Carl Seifert
 * SPDX-FileCopyrightText: 2024-2026 TU Dresden
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once
 
#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"

 
#ifdef __cplusplus
extern "C" {
#endif

/* MARK: - Customizing request behavior */
typedef enum {
    UNICOAP_REQUEST_FLAG_RELIABLE = 0x0001,
} unicoap_request_flags_t;

void unicoap_print_request_flags(unicoap_request_flags_t flags);
 

typedef struct {
    void* callback_arg;

    uint32_t timeout_ms;
} unicoap_request_parameters_t;

 
/* MARK: - Sending a request */
typedef int (*unicoap_response_callback_t)(const unicoap_message_t* response,
                                           const unicoap_aux_t* aux, int error, void* arg);

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);

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);

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); /* end of section */ /* end of group */
 
/* MARK: - Cancellation */

int unicoap_cancel_request(int refno);
 /* end of section */ /* end of group */
 
#ifdef __cplusplus
}
#endif