rte_netlink.h

Go to the documentation of this file.

#ifndef RTE_OS_NETLINK_H
#define RTE_OS_NETLINK_H
 
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

RTE_DECLARE_STORAGE(rte_netlink_storage_t, 64U);

typedef struct rte_netlink_impl_s *rte_netlink_handle_t;

typedef enum rte_netlink_role_e
{
    RTE_NETLINK_ROLE_LISTEN  = 0, 
    RTE_NETLINK_ROLE_CONNECT = 1  
} rte_netlink_role_t;

typedef struct rte_netlink_config_s
{
    rte_netlink_role_t role;
    const char         *host;
    uint16_t             port;
    size_t               message_size;
    rte_duration_ms_t   connect_timeout_ms;
    uint32_t             rcvbuf_bytes;
    uint32_t             sndbuf_bytes;
} rte_netlink_config_t;

rte_status_t rte_netlink_open(rte_netlink_storage_t *storage,
                                 const rte_netlink_config_t *config,
                                 rte_netlink_handle_t *out_handle);

rte_status_t rte_netlink_send(rte_netlink_handle_t handle,
                                 const void *message,
                                 size_t message_size,
                                 rte_duration_ms_t timeout_ms);

rte_status_t rte_netlink_receive(rte_netlink_handle_t handle,
                                    void *out_message,
                                    size_t buffer_size,
                                    rte_duration_ms_t timeout_ms);

rte_status_t rte_netlink_close(rte_netlink_handle_t handle);
 
/*
 * The OSAdapter vtable (rte_osadapter_netlink_t) and
 * rte_osadapter_netlink_register() live in
 * rte_osadapter/netlink/rte_osadapter_netlink.h, not here (ADR-021). This
 * header is the consumer-facing surface only.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_OS_NETLINK_H */
 /* NETLINK */