rte_ipc.h

Go to the documentation of this file.

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

RTE_DECLARE_STORAGE(rte_ipc_storage_t, 64U);

typedef struct rte_ipc_impl_s *rte_ipc_handle_t;

typedef struct rte_ipc_config_s
{
    const char *name;          
    size_t      message_size;  
    size_t      queue_depth;   
} rte_ipc_config_t;

rte_status_t rte_ipc_create(rte_ipc_storage_t *storage,
                               const rte_ipc_config_t *config,
                               rte_ipc_handle_t *out_handle);

rte_status_t rte_ipc_send(rte_ipc_handle_t handle,
                             const void *message,
                             size_t message_size,
                             rte_duration_ms_t timeout_ms);

rte_status_t rte_ipc_receive(rte_ipc_handle_t handle,
                                void *out_message,
                                size_t buffer_size,
                                rte_duration_ms_t timeout_ms);

rte_status_t rte_ipc_destroy(rte_ipc_handle_t handle);
 
/*
 * The OSAdapter vtable (rte_osadapter_ipc_t) and rte_osadapter_ipc_register()
 * live in rte_osadapter/ipc/rte_osadapter_ipc.h, not here (ADR-021).
 * This header is the consumer-facing surface only.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_OS_IPC_H */
 /* IPC */