sapi_channel.h

Go to the documentation of this file.

 
#ifndef SAPI_CHANNEL_LINK_H
#define SAPI_CHANNEL_LINK_H
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
 
#include "safeapi/utils/status/sapi_status.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
    uint32_t send_count;
    uint32_t send_error_count;
    uint32_t receive_count;
    uint32_t receive_error_count;
    bool is_healthy;
    sapi_status_t last_error;
} sapi_channel_health_t;

typedef sapi_status_t (*sapi_channel_send_fn)(void *channel_handle,
                                               const void *data,
                                               size_t data_size);

typedef sapi_status_t (*sapi_channel_recv_fn)(void *channel_handle,
                                               void *data,
                                               size_t data_size,
                                               uint32_t timeout_ms);

typedef struct {
    void *channel_handle;
    sapi_channel_send_fn send;
    sapi_channel_recv_fn recv;
    const char *name;
} sapi_channel_config_t;

typedef struct {
    sapi_channel_config_t config;  
    sapi_channel_health_t health;  
    bool initialized;                    
} sapi_channel_storage_t;

typedef sapi_channel_storage_t sapi_channel_t;

sapi_status_t sapi_channel_init(sapi_channel_storage_t *storage,
                                       const sapi_channel_config_t *config);

sapi_status_t sapi_channel_send(sapi_channel_t *handle,
                                       const void *data,
                                       size_t data_size);

sapi_status_t sapi_channel_receive(sapi_channel_t *handle,
                                          void *data,
                                          size_t data_size,
                                          uint32_t timeout_ms);

sapi_status_t sapi_channel_get_health(const sapi_channel_t *handle,
                                             sapi_channel_health_t *out_health);

const char *sapi_channel_get_name(const sapi_channel_t *handle);

sapi_status_t sapi_channel_set_healthy(sapi_channel_t *handle,
                                              bool is_healthy);

sapi_status_t sapi_channel_destroy(sapi_channel_t *handle);
 
#ifdef __cplusplus
}
#endif

 
#endif /* SAPI_CHANNEL_LINK_H */