18#ifndef IOX_BINDING_C_SUBSCRIBER_H
19#define IOX_BINDING_C_SUBSCRIBER_H
21#include "iceoryx_binding_c/enums.h"
22#include "iceoryx_binding_c/internal/c2cpp_binding.h"
23#include "iceoryx_binding_c/service_description.h"
24#include "iceoryx_binding_c/types.h"
27typedef struct cpp2c_Subscriber* iox_sub_t;
79 const char*
const service,
80 const char*
const instance,
81 const char*
const event,
86void iox_sub_deinit(iox_sub_t
const self);
90void iox_sub_subscribe(iox_sub_t
const self);
94void iox_sub_unsubscribe(iox_sub_t
const self);
100ENUM iox_SubscribeState iox_sub_get_subscription_state(iox_sub_t
const self);
107ENUM iox_ChunkReceiveResult iox_sub_take_chunk(iox_sub_t
const self,
const void**
const userPayload);
112void iox_sub_release_chunk(iox_sub_t
const self,
const void*
const userPayload);
116void iox_sub_release_queued_chunks(iox_sub_t
const self);
121bool iox_sub_has_chunks(iox_sub_t
const self);
126bool iox_sub_has_lost_chunks(iox_sub_t
const self);
Definition: service_description.h:25
options to be set for a subscriber
Definition: subscriber.h:31
ENUM iox_QueueFullPolicy queueFullPolicy
describes whether a publisher blocks when subscriber queue is full
Definition: subscriber.h:46
bool requirePublisherHistorySupport
Indicates whether we require the publisher to have historyCapacity > 0. If true and the condition is ...
Definition: subscriber.h:51
bool subscribeOnCreate
The option whether the subscriber shall try to subscribe when creating it.
Definition: subscriber.h:43
uint64_t historyRequest
number of chunks received after subscription if chunks are available
Definition: subscriber.h:36
uint64_t queueCapacity
size of the history chunk queue
Definition: subscriber.h:33
uint64_t initCheck
this value will be set exclusively by iox_sub_options_init and is not supposed to be modified otherwi...
Definition: subscriber.h:54
const char * nodeName
name of the node the subscriber belongs to
Definition: subscriber.h:40