messaging.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 <stdint.h>
 
#include "net/unicoap.h"


 
#ifdef __cplusplus
extern "C" {
#endif
 
/* MARK: - Private Messaging API */


typedef enum {

    UNICOAP_MESSAGING_FLAG_RELIABLE = 0x01,

    UNICOAP_MESSAGING_FLAG_TRACK = 0x80,
 
    /* MARK: unicoap_driver_extension_point */
} __attribute__((__packed__)) unicoap_messaging_flags_t;

#define UNICOAP_MESSAGING_FLAGS_DEFAULT (0)

typedef union {
    const unicoap_resource_t* resource;
    unicoap_client_memo_t* client;
} unicoap_exchange_arg_t;

typedef enum {
    UNICOAP_PREPROCESSING_ERROR_INVALID_CODE_CLASS = -0x1001,

    UNICOAP_PREPROCESSING_ERROR_UNSUPPORTED = -0x1002,

    UNICOAP_PREPROCESSING_ERROR_RESPONSE_UNEXPECTED = -0x1004,

    UNICOAP_PREPROCESSING_ERROR_NOTIFICATION_UNEXPECTED = -0x100c,

    UNICOAP_PREPROCESSING_ERROR_TRUNCATED = -0x1010,

    UNICOAP_PREPROCESSING_ERROR_REQUEST = -0x1020,

    UNICOAP_PREPROCESSING_SUCCESS_RESPONSE = 0x1001,

    UNICOAP_PREPROCESSING_SUCCESS_REQUEST = 0x1002,
 
} unicoap_preprocessing_result_t;

unicoap_preprocessing_result_t unicoap_exchange_preprocess(unicoap_packet_t* packet,
                                                           unicoap_messaging_flags_t* flags,
                                                           unicoap_exchange_arg_t* arg,
                                                           bool truncated);

int unicoap_exchange_process(unicoap_packet_t* packet, unicoap_exchange_arg_t arg);

typedef enum {
    UNICOAP_MESSAGING_RFC7252_EVENT_RX = 1,

    UNICOAP_MESSAGING_RFC7252_EVENT_TRUNCATED = 1 << 1,

    UNICOAP_MESSAGING_RFC7252_EVENT_SESSION_ESTABLISHED = 1 << 2,
} __attribute__((packed)) unicoap_messaging_rfc7252_event_type_t;

int unicoap_messaging_process_rfc7252(const uint8_t* pdu, size_t size,
    unicoap_messaging_rfc7252_event_type_t event,  unicoap_packet_t* packet);
 
/* MARK: unicoap_driver_extension_point */

int unicoap_messaging_send(
    unicoap_packet_t* packet,
    unicoap_messaging_flags_t flags,
    void* exchange);

int unicoap_messaging_send_rfc7252(
    unicoap_packet_t* packet,
    unicoap_messaging_flags_t flags,
    void* exchange);

void unicoap_generate_token(uint8_t* token);

static inline unicoap_messaging_flags_t
_messaging_flags_resource(unicoap_resource_flags_t resource_flags)
{
    /* We documented other flags are RFU, hence downcasting to the messaging
     flags bitfield width is fine here */
    return (unicoap_messaging_flags_t)resource_flags;
}

static inline unicoap_messaging_flags_t _messaging_flags_client(
    unicoap_request_flags_t request_flags)
{
    /* We documented other flags are RFU, hence downcasting to the messaging
     flags bitfield width is fine here */
    return (unicoap_messaging_flags_t)request_flags;
}

 
/* MARK: - Private Exchange-Layer Server API */
int unicoap_server_process_request(unicoap_packet_t* packet, const unicoap_resource_t* resource);

int unicoap_server_send_response_body(unicoap_packet_t* packet,
                                      const unicoap_resource_t* resource);
 
/* MARK: - Private exchange-layer client API */
int unicoap_client_process_response(unicoap_packet_t* packet, unicoap_client_memo_t* memo);

int unicoap_client_send_request_part(unicoap_packet_t* packet, unicoap_client_memo_t* memo,
                                     unicoap_request_flags_t request_flags);

int unicoap_client_send_request_body(unicoap_message_t* request,
                                     unicoap_endpoint_t* endpoint,
                                     unicoap_callback_t callback,
                                     unicoap_request_parameters_t* parameters,
                                     unicoap_request_flags_t flags);
 
#ifdef __cplusplus
}
#endif