anj_net_api.h

Go to the documentation of this file.

/*
 * Copyright 2023-2025 AVSystem <avsystem@avsystem.com>
 * AVSystem Anjay Lite LwM2M SDK
 * All rights reserved.
 *
 * Licensed under AVSystem Anjay Lite LwM2M Client SDK - Non-Commercial License.
 * See the attached LICENSE file for details.
 */
 
#include <anj/init.h>
 
#ifndef ANJ_NET_API_H
#    define ANJ_NET_API_H
 
#    include <stdbool.h>
#    include <stddef.h>
#    include <stdint.h>
 
#    ifdef __cplusplus
extern "C" {
#    endif
 
#    ifdef ANJ_WITH_SECURITY
#        include <anj/compat/rng.h>
#        include <anj/crypto.h>
#    endif // ANJ_WITH_SECURITY
 
#    define ANJ_NET_OK (0)
 
#    define ANJ_NET_EAGAIN (1)
 
#    define ANJ_NET_EMSGSIZE (2)
 
#    define ANJ_NET_ENOTSUP (3)
 
#    define ANJ_NET_EINPROGRESS (4)
 
typedef enum {
    ANJ_NET_BINDING_UDP = 0,
    ANJ_NET_BINDING_TCP,
    ANJ_NET_BINDING_DTLS,
    ANJ_NET_BINDING_TLS,
    ANJ_NET_BINDING_NON_IP
} anj_net_binding_type_t;
 
typedef enum {
    ANJ_NET_SOCKET_STATE_CLOSED,
 
    ANJ_NET_SOCKET_STATE_SHUTDOWN,
 
    ANJ_NET_SOCKET_STATE_CONNECTED
} anj_net_socket_state_t;
 
typedef enum {
    ANJ_NET_AF_SETTING_UNSPEC,
 
    ANJ_NET_AF_SETTING_FORCE_INET4,
 
    ANJ_NET_AF_SETTING_FORCE_INET6,
 
    ANJ_NET_AF_SETTING_PREFERRED_INET4,
 
    ANJ_NET_AF_SETTING_PREFERRED_INET6
} anj_net_address_family_setting_t;
 
typedef struct {
    anj_net_address_family_setting_t af_setting;
} anj_net_socket_configuration_t;
 
#    ifdef ANJ_WITH_SECURITY
typedef enum {
    ANJ_NET_SECURITY_PSK,
    ANJ_NET_SECURITY_CERTIFICATE,
} anj_net_security_mode_t;
 
typedef struct {
    anj_crypto_security_info_t key;
    anj_crypto_security_info_t identity;
} anj_net_psk_info_t;
 
typedef struct {
    void *empty;
} anj_net_certificate_info_t;
 
typedef struct {
    anj_net_security_mode_t mode;
    union {
        anj_net_psk_info_t psk;
        anj_net_certificate_info_t cert;
    } data;
} anj_net_security_info_t;
 
typedef struct {
    anj_net_security_info_t security;
 
#        ifdef ANJ_WITH_EXTERNAL_CRYPTO_STORAGE
    void *crypto_ctx;
#        endif // ANJ_WITH_EXTERNAL_CRYPTO_STORAGE
} anj_net_ssl_configuration_t;
#    endif // ANJ_WITH_SECURITY
 
typedef struct {
    anj_net_socket_configuration_t raw_socket_config;
#    ifdef ANJ_WITH_SECURITY
    anj_net_ssl_configuration_t secure_socket_config;
#    endif // ANJ_WITH_SECURITY
} anj_net_config_t;
 
struct anj_net_ctx_struct;
 
typedef struct anj_net_ctx_struct anj_net_ctx_t;
 
static inline bool anj_net_is_ok(int res) {
    return ANJ_NET_OK == res;
}
 
static inline bool anj_net_is_again(int res) {
    return ANJ_NET_EAGAIN == res;
}
 
static inline bool anj_net_is_inprogress(int res) {
    return ANJ_NET_EINPROGRESS == res;
}
 
typedef int anj_net_create_ctx_t(anj_net_ctx_t **ctx,
                                 const anj_net_config_t *config);
 
typedef int anj_net_cleanup_ctx_t(anj_net_ctx_t **ctx);
 
typedef int
anj_net_connect_t(anj_net_ctx_t *ctx, const char *hostname, const char *port);
 
typedef int anj_net_send_t(anj_net_ctx_t *ctx,
                           size_t *bytes_sent,
                           const uint8_t *buf,
                           size_t length);
 
typedef int anj_net_recv_t(anj_net_ctx_t *ctx,
                           size_t *bytes_received,
                           uint8_t *buf,
                           size_t length);
 
typedef int anj_net_shutdown_t(anj_net_ctx_t *ctx);
 
typedef int anj_net_close_t(anj_net_ctx_t *ctx);
 
typedef int anj_net_get_state_t(anj_net_ctx_t *ctx,
                                anj_net_socket_state_t *out_value);
 
typedef int anj_net_get_inner_mtu_t(anj_net_ctx_t *ctx, int32_t *out_value);
 
typedef int anj_net_queue_mode_rx_off_t(anj_net_ctx_t *ctx);
 
#    ifdef __cplusplus
}
#    endif
 
#endif // ANJ_NET_API_H