iceoryx_doc  1.0.1
wait_set.h
1 // Copyright (c) 2020 by Robert Bosch GmbH. All rights reserved.
2 // Copyright (c) 2020 - 2021 Apex.AI Inc. All rights reserved.
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 // http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 //
16 // SPDX-License-Identifier: Apache-2.0
17 
18 #ifndef IOX_BINDING_C_WAIT_SET_H
19 #define IOX_BINDING_C_WAIT_SET_H
20 
21 #include "iceoryx_binding_c/enums.h"
22 #include "iceoryx_binding_c/internal/c2cpp_binding.h"
23 #include "iceoryx_binding_c/notification_info.h"
24 #include "iceoryx_binding_c/subscriber.h"
25 #include "iceoryx_binding_c/types.h"
26 #include "iceoryx_binding_c/user_trigger.h"
27 
28 #include <time.h>
29 
31 typedef CLASS cpp2c_WaitSet* iox_ws_t;
32 
36 iox_ws_t iox_ws_init(iox_ws_storage_t* self);
37 
40 void iox_ws_deinit(iox_ws_t const self);
41 
51 uint64_t iox_ws_timed_wait(iox_ws_t const self,
52  struct timespec timeout,
53  iox_notification_info_t* const notificationInfoArray,
54  const uint64_t notificationInfoArrayCapacity,
55  uint64_t* missedElements);
56 
65 uint64_t iox_ws_wait(iox_ws_t const self,
66  iox_notification_info_t* const notificationInfoArray,
67  const uint64_t notificationInfoArrayCapacity,
68  uint64_t* missedElements);
69 
71 uint64_t iox_ws_size(iox_ws_t const self);
72 
74 uint64_t iox_ws_capacity(iox_ws_t const self);
75 
80 void iox_ws_mark_for_destruction(iox_ws_t const self);
81 
90 ENUM iox_WaitSetResult iox_ws_attach_subscriber_state(iox_ws_t const self,
91  iox_sub_t const subscriber,
92  const ENUM iox_SubscriberState subscriberState,
93  const uint64_t id,
94  void (*callback)(iox_sub_t));
95 
106 ENUM iox_WaitSetResult iox_ws_attach_subscriber_state_with_context_data(iox_ws_t const self,
107  iox_sub_t const subscriber,
108  const ENUM iox_SubscriberState subscriberState,
109  const uint64_t id,
110  void (*callback)(iox_sub_t, void*),
111  void* const contextData);
112 
121 ENUM iox_WaitSetResult iox_ws_attach_subscriber_event(iox_ws_t const self,
122  iox_sub_t const subscriber,
123  const ENUM iox_SubscriberEvent subscriberEvent,
124  const uint64_t eventId,
125  void (*callback)(iox_sub_t));
126 
137 ENUM iox_WaitSetResult iox_ws_attach_subscriber_event_with_context_data(iox_ws_t const self,
138  iox_sub_t const subscriber,
139  const ENUM iox_SubscriberEvent subscriberEvent,
140  const uint64_t eventId,
141  void (*callback)(iox_sub_t, void*),
142  void* const contextData);
143 
151 ENUM iox_WaitSetResult iox_ws_attach_user_trigger_event(iox_ws_t const self,
152  iox_user_trigger_t const userTrigger,
153  const uint64_t eventId,
154  void (*callback)(iox_user_trigger_t));
155 
165 ENUM iox_WaitSetResult iox_ws_attach_user_trigger_event_with_context_data(iox_ws_t const self,
166  iox_user_trigger_t const userTrigger,
167  const uint64_t eventId,
168  void (*callback)(iox_user_trigger_t, void*),
169  void* const contextData);
170 
175 void iox_ws_detach_subscriber_event(iox_ws_t const self,
176  iox_sub_t const subscriber,
177  const ENUM iox_SubscriberEvent subscriberEvent);
178 
183 void iox_ws_detach_subscriber_state(iox_ws_t const self,
184  iox_sub_t const subscriber,
185  const ENUM iox_SubscriberState subscriberState);
186 
190 void iox_ws_detach_user_trigger_event(iox_ws_t const self, iox_user_trigger_t const userTrigger);
191 
192 #endif
Definition: cpp2c_waitset.hpp:23
Definition: cpp2c_subscriber.hpp:28
Definition: types.h:35