Safe API Framework
Layered API framework for safety-related applications (ERTMS RBC reference targeting CENELEC EN 50128 SIL 4)
Loading...
Searching...
No Matches
sapi_ipc_backend_t Struct Reference
Inter-Process Communication - Backend Adaptation

Backend vtable: an integrator's implementation of the IPC service for a specific OS/RTOS (ADR-005). Any slot may be NULL if unsupported by the backend (-> SAPI_STATUS_NOT_SUPPORTED). More...

#include <sapi_ipc_backend.h>

Data Fields

sapi_status_t(*) create (sapi_ipc_storage_t *storage, const sapi_ipc_config_t *config, sapi_ipc_handle_t *out_handle)
 Backend implementation of sapi_ipc_create(). May be NULL.
sapi_status_t(*) send (sapi_ipc_handle_t handle, const void *message, size_t message_size, sapi_duration_ms_t timeout_ms)
 Backend implementation of sapi_ipc_send(). May be NULL.
sapi_status_t(*) receive (sapi_ipc_handle_t handle, void *out_message, size_t buffer_size, sapi_duration_ms_t timeout_ms)
 Backend implementation of sapi_ipc_receive(). May be NULL.
sapi_status_t(*) destroy (sapi_ipc_handle_t handle)
 Backend implementation of sapi_ipc_destroy(). May be NULL.

Detailed Description

Backend vtable: an integrator's implementation of the IPC service for a specific OS/RTOS (ADR-005). Any slot may be NULL if unsupported by the backend (-> SAPI_STATUS_NOT_SUPPORTED).

Definition at line 30 of file sapi_ipc_backend.h.

Field Documentation

◆ create

sapi_status_t(*) sapi_ipc_backend_t::create(sapi_ipc_storage_t *storage, const sapi_ipc_config_t *config, sapi_ipc_handle_t *out_handle)

Backend implementation of sapi_ipc_create(). May be NULL.

Definition at line 33 of file sapi_ipc_backend.h.

◆ send

sapi_status_t(*) sapi_ipc_backend_t::send(sapi_ipc_handle_t handle, const void *message, size_t message_size, sapi_duration_ms_t timeout_ms)

Backend implementation of sapi_ipc_send(). May be NULL.

Definition at line 37 of file sapi_ipc_backend.h.

◆ receive

sapi_status_t(*) sapi_ipc_backend_t::receive(sapi_ipc_handle_t handle, void *out_message, size_t buffer_size, sapi_duration_ms_t timeout_ms)

Backend implementation of sapi_ipc_receive(). May be NULL.

Definition at line 40 of file sapi_ipc_backend.h.

◆ destroy

sapi_status_t(*) sapi_ipc_backend_t::destroy(sapi_ipc_handle_t handle)

Backend implementation of sapi_ipc_destroy(). May be NULL.

Definition at line 43 of file sapi_ipc_backend.h.

The documentation for this struct was generated from the following file: