sapi_netlink.h

Go to the documentation of this file.

#ifndef SAFEAPI_OS_NETLINK_H
#define SAFEAPI_OS_NETLINK_H
 
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

SAFEAPI_DECLARE_STORAGE(sapi_netlink_storage_t, 64U);

typedef struct sapi_netlink_impl_s *sapi_netlink_handle_t;

typedef enum sapi_netlink_role_e
{
    SAPI_NETLINK_ROLE_LISTEN  = 0, 
    SAPI_NETLINK_ROLE_CONNECT = 1  
} sapi_netlink_role_t;

typedef struct sapi_netlink_config_s
{
    sapi_netlink_role_t role;
    const char         *host;
    uint16_t             port;
    size_t               message_size;
    sapi_duration_ms_t   connect_timeout_ms;
} sapi_netlink_config_t;

sapi_status_t sapi_netlink_open(sapi_netlink_storage_t *storage,
                                 const sapi_netlink_config_t *config,
                                 sapi_netlink_handle_t *out_handle);

sapi_status_t sapi_netlink_send(sapi_netlink_handle_t handle,
                                 const void *message,
                                 size_t message_size,
                                 sapi_duration_ms_t timeout_ms);

sapi_status_t sapi_netlink_receive(sapi_netlink_handle_t handle,
                                    void *out_message,
                                    size_t buffer_size,
                                    sapi_duration_ms_t timeout_ms);

sapi_status_t sapi_netlink_close(sapi_netlink_handle_t handle);
 
/*
 * The backend vtable (sapi_netlink_backend_t) and
 * sapi_netlink_register_backend() live in
 * safeapi_backend/netlink/sapi_netlink_backend.h, not here (ADR-021). This
 * header is the consumer-facing surface only.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAFEAPI_OS_NETLINK_H */
 /* NETLINK */