sapi_ipc.h

Go to the documentation of this file.

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

SAFEAPI_DECLARE_STORAGE(sapi_ipc_storage_t, 64U);

typedef struct sapi_ipc_impl_s *sapi_ipc_handle_t;

typedef struct sapi_ipc_config_s
{
    const char *name;          
    size_t      message_size;  
    size_t      queue_depth;   
} sapi_ipc_config_t;

sapi_status_t sapi_ipc_create(sapi_ipc_storage_t *storage,
                               const sapi_ipc_config_t *config,
                               sapi_ipc_handle_t *out_handle);

sapi_status_t sapi_ipc_send(sapi_ipc_handle_t handle,
                             const void *message,
                             size_t message_size,
                             sapi_duration_ms_t timeout_ms);

sapi_status_t sapi_ipc_receive(sapi_ipc_handle_t handle,
                                void *out_message,
                                size_t buffer_size,
                                sapi_duration_ms_t timeout_ms);

sapi_status_t sapi_ipc_destroy(sapi_ipc_handle_t handle);
 
/*
 * The backend vtable (sapi_ipc_backend_t) and sapi_ipc_register_backend()
 * live in safeapi_backend/ipc/sapi_ipc_backend.h, not here (ADR-021).
 * This header is the consumer-facing surface only.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAFEAPI_OS_IPC_H */
 /* IPC */