summaryrefslogtreecommitdiffstats
path: root/include/afb/afb-daemon-itf-x1.h
blob: 7b602a61af58cc660c54ebd03d8f9cb94147a15d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
/*
 * Copyright (C) 2016-2019 "IoT.bzh"
 * Author: José Bollo <jose.bollo@iot.bzh>
 *
 * 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 <stdarg.h>

/* declaration of features of libsystemd */
struct sd_event;
struct sd_bus;
struct afb_stored_req;
struct afb_req_x1;
struct afb_event_x1;
struct afb_api_x3;

/** @defgroup AFB_DAEMON
 *  @{ */

/**
 * @deprecated use bindings version 3
 *
 * Definition of the facilities provided by the daemon.
 */
struct afb_daemon_itf_x1
{
	/** broadcasts evant 'name' with 'object' */
	int (*event_broadcast)(struct afb_api_x3 *closure, const char *name, struct json_object *object);

	/** gets the common systemd's event loop */
	struct sd_event *(*get_event_loop)(struct afb_api_x3 *closure);

	/** gets the common systemd's user d-bus */
	struct sd_bus *(*get_user_bus)(struct afb_api_x3 *closure);

	/** gets the common systemd's system d-bus */
	struct sd_bus *(*get_system_bus)(struct afb_api_x3 *closure);

	/** logging messages */
	void (*vverbose_v1)(struct afb_api_x3*closure, int level, const char *file, int line, const char *fmt, va_list args);

	/** creates an event of 'name' */
	struct afb_event_x1 (*event_make)(struct afb_api_x3 *closure, const char *name);

	/** get the file descriptor of the install directory */
	int (*rootdir_get_fd)(struct afb_api_x3 *closure);

	/** opens a file of the install directory */
	int (*rootdir_open_locale)(struct afb_api_x3 *closure, const char *filename, int flags, const char *locale);

	/** queue a job */
	int (*queue_job)(struct afb_api_x3 *closure, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout);

	/** logging messages */
	void (*vverbose_v2)(struct afb_api_x3*closure, int level, const char *file, int line, const char * func, const char *fmt, va_list args);

	/** retrieve a stored request */
	struct afb_req_x1 (*unstore_req)(struct afb_api_x3*closure, struct afb_stored_req *sreq);

	/** require an api */
	int (*require_api)(struct afb_api_x3*closure, const char *name, int initialized);

	/** aliases an api */
	int (*add_alias)(struct afb_api_x3*closure, const char *name, const char *as_name);

	/** creates a new api */
	struct afb_api_x3 *(*new_api)(struct afb_api_x3 *closure, const char *api, const char *info, int noconcurrency, int (*preinit)(void*, struct afb_api_x3 *), void *preinit_closure);
};

/**
 * @deprecated use bindings version 3
 *
 * 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_x1
{
	const struct afb_daemon_itf_x1 *itf;    /**< the interfacing functions */
	struct afb_api_x3 *closure;             /**< the closure when calling these functions */
};

/** @} */