libamxb  4.8.2
Bus Agnostic C API
amxb_priv.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** SPDX-License-Identifier: BSD-2-Clause-Patent
4 **
5 ** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
6 **
7 ** Redistribution and use in source and binary forms, with or without modification,
8 ** are permitted provided that the following conditions are met:
9 **
10 ** 1. Redistributions of source code must retain the above copyright notice,
11 ** this list of conditions and the following disclaimer.
12 **
13 ** 2. Redistributions in binary form must reproduce the above copyright notice,
14 ** this list of conditions and the following disclaimer in the documentation
15 ** and/or other materials provided with the distribution.
16 **
17 ** Subject to the terms and conditions of this license, each copyright holder
18 ** and contributor hereby grants to those receiving rights under this license
19 ** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
20 ** (except for failure to satisfy the conditions of this license) patent license
21 ** to make, have made, use, offer to sell, sell, import, and otherwise transfer
22 ** this software, where such license applies only to those patent claims, already
23 ** acquired or hereafter acquired, licensable by such copyright holder or contributor
24 ** that are necessarily infringed by:
25 **
26 ** (a) their Contribution(s) (the licensed copyrights of copyright holders and
27 ** non-copyrightable additions of contributors, in source or binary form) alone;
28 ** or
29 **
30 ** (b) combination of their Contribution(s) with the work of authorship to which
31 ** such Contribution(s) was added by such copyright holder or contributor, if,
32 ** at the time the Contribution is added, such addition causes such combination
33 ** to be necessarily infringed. The patent license shall not apply to any other
34 ** combinations which include the Contribution.
35 **
36 ** Except as expressly stated above, no rights or licenses from any copyright
37 ** holder or contributor is granted under this license, whether expressly, by
38 ** implication, estoppel or otherwise.
39 **
40 ** DISCLAIMER
41 **
42 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
43 ** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 ** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
46 ** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
48 ** SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
49 ** CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 ** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
51 ** USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52 **
53 ****************************************************************************/
54 #if !defined(__AMXB_PRIV_H__)
55 #define __AMXB_PRIV_H__
56 
57 #ifdef __cplusplus
58 extern "C"
59 {
60 #endif
61 
62 #include <amxc/amxc_macros.h>
63 
64 typedef struct _sub {
65  amxc_llist_it_t it;
68 
69 typedef struct _req {
70  amxc_llist_it_t it;
72  bool local;
73  bool in_flight;
74  bool closed;
75  bool wait;
77 
78 #define amxb_is_valid_be_func(ft, member, ptr) \
79  (ft != NULL && offsetof(amxb_be_funcs_t, member) < ft->size && ptr != NULL)
80 
81 void PRIVATE amxb_dm_event_to_object_event(const char* const sig_name,
82  const amxc_var_t* const data,
83  void* const priv);
84 
85 amxd_object_t* amxb_fetch_local_object(amxb_bus_ctx_t* ctx,
86  const char* object);
87 
88 bool PRIVATE amxb_is_local_object(amxb_bus_ctx_t* ctx,
89  const char* obj_path);
90 
91 int PRIVATE amxb_subscription_remove(amxb_subscription_t* subscription);
92 
93 int PRIVATE amxb_set_impl(amxb_bus_ctx_t* const bus_ctx,
94  const char* object,
95  uint32_t flags,
96  amxc_var_t* values,
97  amxc_var_t* ovalues,
98  amxc_var_t* ret,
99  int timeout);
100 
101 int PRIVATE amxb_follow_reference(amxb_bus_ctx_t* const bus_ctx,
102  amxd_path_t* reference,
103  int timeout);
104 
106 
107 amxb_bus_ctx_t* amxb_be_who_has_impl(const char* object_path, bool full_match);
108 
109 #ifdef __cplusplus
110 }
111 #endif
112 
113 #endif // __AMXB_PRIV_H__
int PRIVATE amxb_subscription_remove(amxb_subscription_t *subscription)
struct _req amxb_req_t
amxd_object_t * amxb_fetch_local_object(amxb_bus_ctx_t *ctx, const char *object)
Definition: amxb_ba_priv.c:87
amxb_bus_ctx_t * amxb_be_who_has_impl(const char *object_path, bool full_match)
int PRIVATE amxb_set_impl(amxb_bus_ctx_t *const bus_ctx, const char *object, uint32_t flags, amxc_var_t *values, amxc_var_t *ovalues, amxc_var_t *ret, int timeout)
int PRIVATE amxb_follow_reference(amxb_bus_ctx_t *const bus_ctx, amxd_path_t *reference, int timeout)
Definition: amxb_ba_priv.c:116
struct _sub amxb_sub_t
bool PRIVATE amxb_is_local_object(amxb_bus_ctx_t *ctx, const char *obj_path)
Definition: amxb_ba_priv.c:94
uint32_t PRIVATE amxb_be_get_capabilities(amxb_bus_ctx_t *bus_ctx)
Definition: amxb_ba_priv.c:157
void PRIVATE amxb_dm_event_to_object_event(const char *const sig_name, const amxc_var_t *const data, void *const priv)
Definition: amxb_ba_priv.c:76
A request structure.
Definition: amxb_types.h:138
Definition: amxb_priv.h:69
bool in_flight
Definition: amxb_priv.h:73
bool closed
Definition: amxb_priv.h:74
amxc_llist_it_t it
Definition: amxb_priv.h:70
amxb_request_t data
Definition: amxb_priv.h:71
bool wait
Definition: amxb_priv.h:75
bool local
Definition: amxb_priv.h:72
Definition: amxb_priv.h:64
amxc_llist_it_t it
Definition: amxb_priv.h:65
amxb_subscription_t data
Definition: amxb_priv.h:66
static amxb_bus_ctx_t * bus_ctx
Definition: test_amxb_e2e.c:84