From 7f4444176bd6efaa5e189a148351bab5a72c2853 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 22 Sep 2017 16:31:15 +0200 Subject: Cleanup of header files MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Icf6cffdf303e125feec2661f5ce736a398c07932 Signed-off-by: José Bollo --- include/afb/afb-binding-v1.h | 4 +-- include/afb/afb-binding-v2.h | 4 +-- include/afb/afb-daemon-common.h | 59 ---------------------------------------- include/afb/afb-daemon-itf.h | 59 ++++++++++++++++++++++++++++++++++++++++ include/afb/afb-daemon-v1.h | 2 +- include/afb/afb-daemon-v2.h | 2 +- include/afb/afb-event-itf.h | 26 ------------------ include/afb/afb-req-itf.h | 26 ------------------ include/afb/afb-service-common.h | 48 -------------------------------- include/afb/afb-service-itf.h | 32 ++++++++++++++++++---- include/afb/afb-service-v1.h | 2 +- include/afb/afb-service-v2.h | 2 +- 12 files changed, 94 insertions(+), 172 deletions(-) delete mode 100644 include/afb/afb-daemon-common.h create mode 100644 include/afb/afb-daemon-itf.h delete mode 100644 include/afb/afb-event-itf.h delete mode 100644 include/afb/afb-req-itf.h delete mode 100644 include/afb/afb-service-common.h diff --git a/include/afb/afb-binding-v1.h b/include/afb/afb-binding-v1.h index bafb8761..79254cd8 100644 --- a/include/afb/afb-binding-v1.h +++ b/include/afb/afb-binding-v1.h @@ -21,8 +21,8 @@ struct json_object; #include "afb-req.h" #include "afb-event.h" -#include "afb-service-common.h" -#include "afb-daemon-common.h" +#include "afb-service-itf.h" +#include "afb-daemon-itf.h" #include "afb-req-v1.h" #include "afb-session-v1.h" diff --git a/include/afb/afb-binding-v2.h b/include/afb/afb-binding-v2.h index 621ddce6..e0ade91a 100644 --- a/include/afb/afb-binding-v2.h +++ b/include/afb/afb-binding-v2.h @@ -22,8 +22,8 @@ #include "afb-auth.h" #include "afb-event.h" #include "afb-req.h" -#include "afb-service-common.h" -#include "afb-daemon-common.h" +#include "afb-service-itf.h" +#include "afb-daemon-itf.h" #include "afb-req-v2.h" #include "afb-session-v2.h" diff --git a/include/afb/afb-daemon-common.h b/include/afb/afb-daemon-common.h deleted file mode 100644 index b78f9af9..00000000 --- a/include/afb/afb-daemon-common.h +++ /dev/null @@ -1,59 +0,0 @@ -/* - * Copyright (C) 2016, 2017 "IoT.bzh" - * Author: José Bollo - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#pragma once - -#include - -/* declaration of features of libsystemd */ -struct sd_event; -struct sd_bus; -struct afb_stored_req; -struct afb_req; -struct afb_dynapi; - -/* - * Definition of the facilities provided by the daemon. - */ -struct afb_daemon_itf -{ - int (*event_broadcast)(void *closure, const char *name, struct json_object *object); /* broadcasts evant 'name' with 'object' */ - struct sd_event *(*get_event_loop)(void *closure); /* gets the common systemd's event loop */ - struct sd_bus *(*get_user_bus)(void *closure); /* gets the common systemd's user d-bus */ - struct sd_bus *(*get_system_bus)(void *closure); /* gets the common systemd's system d-bus */ - void (*vverbose_v1)(void*closure, int level, const char *file, int line, const char *fmt, va_list args); - struct afb_event (*event_make)(void *closure, const char *name); /* creates an event of 'name' */ - int (*rootdir_get_fd)(void *closure); - int (*rootdir_open_locale)(void *closure, const char *filename, int flags, const char *locale); - int (*queue_job)(void *closure, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout); - void (*vverbose_v2)(void*closure, int level, const char *file, int line, const char * func, const char *fmt, va_list args); - struct afb_req (*unstore_req)(void*closure, struct afb_stored_req *sreq); - int (*require_api)(void*closure, const char *name, int initialized); - int (*rename_api)(void*closure, const char *name); - int (*new_api)(void *closure, const char *api, const char *info, int (*preinit)(void*, struct afb_dynapi *), void *preinit_closure); -}; - -/* - * Structure for accessing daemon. - * See also: afb_daemon_get_event_sender, afb_daemon_get_event_loop, afb_daemon_get_user_bus, afb_daemon_get_system_bus - */ -struct afb_daemon -{ - const struct afb_daemon_itf *itf; /* the interfacing functions */ - void *closure; /* the closure when calling these functions */ -}; - diff --git a/include/afb/afb-daemon-itf.h b/include/afb/afb-daemon-itf.h new file mode 100644 index 00000000..b78f9af9 --- /dev/null +++ b/include/afb/afb-daemon-itf.h @@ -0,0 +1,59 @@ +/* + * Copyright (C) 2016, 2017 "IoT.bzh" + * Author: José Bollo + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#pragma once + +#include + +/* declaration of features of libsystemd */ +struct sd_event; +struct sd_bus; +struct afb_stored_req; +struct afb_req; +struct afb_dynapi; + +/* + * Definition of the facilities provided by the daemon. + */ +struct afb_daemon_itf +{ + int (*event_broadcast)(void *closure, const char *name, struct json_object *object); /* broadcasts evant 'name' with 'object' */ + struct sd_event *(*get_event_loop)(void *closure); /* gets the common systemd's event loop */ + struct sd_bus *(*get_user_bus)(void *closure); /* gets the common systemd's user d-bus */ + struct sd_bus *(*get_system_bus)(void *closure); /* gets the common systemd's system d-bus */ + void (*vverbose_v1)(void*closure, int level, const char *file, int line, const char *fmt, va_list args); + struct afb_event (*event_make)(void *closure, const char *name); /* creates an event of 'name' */ + int (*rootdir_get_fd)(void *closure); + int (*rootdir_open_locale)(void *closure, const char *filename, int flags, const char *locale); + int (*queue_job)(void *closure, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout); + void (*vverbose_v2)(void*closure, int level, const char *file, int line, const char * func, const char *fmt, va_list args); + struct afb_req (*unstore_req)(void*closure, struct afb_stored_req *sreq); + int (*require_api)(void*closure, const char *name, int initialized); + int (*rename_api)(void*closure, const char *name); + int (*new_api)(void *closure, const char *api, const char *info, int (*preinit)(void*, struct afb_dynapi *), void *preinit_closure); +}; + +/* + * Structure for accessing daemon. + * See also: afb_daemon_get_event_sender, afb_daemon_get_event_loop, afb_daemon_get_user_bus, afb_daemon_get_system_bus + */ +struct afb_daemon +{ + const struct afb_daemon_itf *itf; /* the interfacing functions */ + void *closure; /* the closure when calling these functions */ +}; + diff --git a/include/afb/afb-daemon-v1.h b/include/afb/afb-daemon-v1.h index 9ac4f916..d1a0cc2a 100644 --- a/include/afb/afb-daemon-v1.h +++ b/include/afb/afb-daemon-v1.h @@ -17,7 +17,7 @@ #pragma once -#include "afb-daemon-common.h" +#include "afb-daemon-itf.h" /* * Retrieves the common systemd's event loop of AFB diff --git a/include/afb/afb-daemon-v2.h b/include/afb/afb-daemon-v2.h index 186fc6d6..1ea40e96 100644 --- a/include/afb/afb-daemon-v2.h +++ b/include/afb/afb-daemon-v2.h @@ -17,7 +17,7 @@ #pragma once -#include "afb-daemon-common.h" +#include "afb-daemon-itf.h" /* * Retrieves the common systemd's event loop of AFB diff --git a/include/afb/afb-event-itf.h b/include/afb/afb-event-itf.h deleted file mode 100644 index 8f2bfc78..00000000 --- a/include/afb/afb-event-itf.h +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (C) 2016, 2017 "IoT.bzh" - * Author: José Bollo - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#pragma once - -#pragma GCC warning "\n\n\ - This header file is OBSOLETE.\n\ - It is provided for COMPATIBILITY ONLY.\n\n\ - Please USE and ADAPT YOUR CODE to new names.\n" - -#include "afb-binding.h" - diff --git a/include/afb/afb-req-itf.h b/include/afb/afb-req-itf.h deleted file mode 100644 index bf044f1c..00000000 --- a/include/afb/afb-req-itf.h +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (C) 2016, 2017 "IoT.bzh" - * Author: José Bollo - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#pragma once - -#pragma GCC warning "\n\n\ - This header file is OBSOLETE.\n\ - It is provided for COMPATIBILITY ONLY.\n\n\ - Please USE and ADAPT YOUR CODE to new names.\n" - -#include "afb-binding.h" - diff --git a/include/afb/afb-service-common.h b/include/afb/afb-service-common.h deleted file mode 100644 index 081b1db6..00000000 --- a/include/afb/afb-service-common.h +++ /dev/null @@ -1,48 +0,0 @@ -/* - * Copyright (C) 2016, 2017 "IoT.bzh" - * Author: José Bollo - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#pragma once - -/* avoid inclusion of */ -struct json_object; - -/* - * Interface for internal of services - * It records the functions to be called for the request. - * Don't use this structure directly. - * Use the helper functions documented below. - */ -struct afb_service_itf -{ - /* CAUTION: respect the order, add at the end */ - - void (*call)(void *closure, const char *api, const char *verb, struct json_object *args, - void (*callback)(void*, int, struct json_object*), void *callback_closure); - - int (*call_sync)(void *closure, const char *api, const char *verb, struct json_object *args, - struct json_object **result); -}; - -/* - * Object that encapsulate accesses to service items - */ -struct afb_service -{ - const struct afb_service_itf *itf; - void *closure; -}; - diff --git a/include/afb/afb-service-itf.h b/include/afb/afb-service-itf.h index 490d77e7..081b1db6 100644 --- a/include/afb/afb-service-itf.h +++ b/include/afb/afb-service-itf.h @@ -17,10 +17,32 @@ #pragma once -#pragma GCC warning "\n\n\ - This header file is OBSOLETE.\n\ - It is provided for COMPATIBILITY ONLY.\n\n\ - Please USE and ADAPT YOUR CODE to new names.\n" +/* avoid inclusion of */ +struct json_object; -#include "afb-binding.h" +/* + * Interface for internal of services + * It records the functions to be called for the request. + * Don't use this structure directly. + * Use the helper functions documented below. + */ +struct afb_service_itf +{ + /* CAUTION: respect the order, add at the end */ + + void (*call)(void *closure, const char *api, const char *verb, struct json_object *args, + void (*callback)(void*, int, struct json_object*), void *callback_closure); + + int (*call_sync)(void *closure, const char *api, const char *verb, struct json_object *args, + struct json_object **result); +}; + +/* + * Object that encapsulate accesses to service items + */ +struct afb_service +{ + const struct afb_service_itf *itf; + void *closure; +}; diff --git a/include/afb/afb-service-v1.h b/include/afb/afb-service-v1.h index db798382..61a01e28 100644 --- a/include/afb/afb-service-v1.h +++ b/include/afb/afb-service-v1.h @@ -17,7 +17,7 @@ #pragma once -#include "afb-service-common.h" +#include "afb-service-itf.h" /** * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding. diff --git a/include/afb/afb-service-v2.h b/include/afb/afb-service-v2.h index 08974c9d..75a262be 100644 --- a/include/afb/afb-service-v2.h +++ b/include/afb/afb-service-v2.h @@ -17,7 +17,7 @@ #pragma once -#include "afb-service-common.h" +#include "afb-service-itf.h" /** * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding. -- cgit 1.2.3-korg