sapi_ipc_pubsub.h

Go to the documentation of this file.

 
#ifndef SAFEAPI_IPC_PUBSUB_H
#define SAFEAPI_IPC_PUBSUB_H
 
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"
#include "sapi_ipc.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================
 * Publish-Subscribe Topic
 * ========================================================================== */

typedef struct sapi_ipc_pubsub_topic_s *sapi_ipc_pubsub_topic_t;

typedef struct {
    const char *topic_name;        
    size_t message_size;           
    size_t max_subscribers;        
} sapi_ipc_pubsub_topic_config_t;

sapi_status_t sapi_ipc_pubsub_topic_create(sapi_ipc_pubsub_topic_t *topic_out,
                                            const sapi_ipc_pubsub_topic_config_t *config);

sapi_status_t sapi_ipc_pubsub_publish(sapi_ipc_pubsub_topic_t topic,
                                       const void *message,
                                       size_t message_size);

sapi_status_t sapi_ipc_pubsub_topic_destroy(sapi_ipc_pubsub_topic_t topic);
 
/* ============================================================================
 * Subscriber (Receiver Side)
 * ========================================================================== */

typedef struct sapi_ipc_pubsub_subscriber_s *sapi_ipc_pubsub_subscriber_t;

typedef struct {
    const char *subscriber_name;   
    sapi_ipc_pubsub_topic_t topic; 
    size_t queue_depth;            
} sapi_ipc_pubsub_subscriber_config_t;

sapi_status_t sapi_ipc_pubsub_subscribe(sapi_ipc_pubsub_subscriber_t *subscriber_out,
                                         const sapi_ipc_pubsub_subscriber_config_t *config);

sapi_status_t sapi_ipc_pubsub_receive(sapi_ipc_pubsub_subscriber_t subscriber,
                                       void *message_out,
                                       size_t message_size,
                                       sapi_duration_ms_t timeout_ms);

sapi_status_t sapi_ipc_pubsub_unsubscribe(sapi_ipc_pubsub_subscriber_t subscriber);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAFEAPI_IPC_PUBSUB_H */