rte_channel_service.h

Go to the documentation of this file.

#ifndef RTE_CHANNEL_SERVICE_H
#define RTE_CHANNEL_SERVICE_H

 
#include <stddef.h>
#include <stdint.h>
 
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define RTE_CHANNEL_SERVICE_NAME_SIZE (32U)

typedef struct
{
    uint8_t reserved[128U];
} rte_channel_service_storage_t;

typedef rte_channel_service_storage_t rte_channel_service_t;

typedef struct
{
    rte_status_t (*setup)(rte_channel_service_storage_t *storage,
                           const char *channel_name);
    rte_status_t (*read)(rte_channel_service_storage_t *storage,
                          void *data,
                          size_t data_size,
                          rte_duration_ms_t timeout_ms);
    rte_status_t (*send)(rte_channel_service_storage_t *storage,
                          const void *data,
                          size_t data_size,
                          rte_duration_ms_t timeout_ms);
    rte_status_t (*close)(rte_channel_service_storage_t *storage);
    rte_status_t (*read_ex)(rte_channel_service_storage_t *storage,
                             void *data,
                             size_t data_size,
                             rte_duration_ms_t timeout_ms,
                             size_t *out_actual_size);
} rte_osadapter_channel_service_t;

rte_status_t rte_osadapter_channel_service_register(const rte_osadapter_channel_service_t *osadapter);
 
rte_status_t rte_channel_service_setup(rte_channel_service_t *storage, const char *channel_name);
rte_status_t rte_channel_service_setup_by_id(rte_channel_service_t *storage, uint32_t channel_id);
rte_status_t rte_channel_service_read(rte_channel_service_t *storage,
                                         void *data,
                                         size_t data_size,
                                         rte_duration_ms_t timeout_ms);
rte_status_t rte_channel_service_read_ex(rte_channel_service_t *storage,
                                          void *data,
                                          size_t data_size,
                                          rte_duration_ms_t timeout_ms,
                                          size_t *out_actual_size);
rte_status_t rte_channel_service_send(rte_channel_service_t *storage,
                                         const void *data,
                                         size_t data_size,
                                         rte_duration_ms_t timeout_ms);
rte_status_t rte_channel_service_close(rte_channel_service_t *storage);
 
#ifdef __cplusplus
}
#endif
 
#endif