summaryrefslogtreecommitdiff
path: root/include/client_life.h
blob: 446b952beb38029e74394834317fa9611ca86d30 (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
96
97
98
99
100
101
102
103
104
105
106
107
/*
 * Copyright 2013  Samsung Electronics Co., Ltd
 *
 * Licensed under the Flora License, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://floralicense.org/license/
 *
 * 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.
 */

enum client_event {
	CLIENT_EVENT_ACTIVATE,
	CLIENT_EVENT_DEACTIVATE,
};

enum client_global_event {
	CLIENT_GLOBAL_EVENT_CREATE,
	CLIENT_GLOBAL_EVENT_DESTROY,
};

struct inst_info;
struct packet;

/*!
 * \note
 * Create & Destroy
 */
extern struct client_node *client_create(pid_t pid, int handle);
#define client_destroy(client)	client_unref(client)

/*!
 * \note
 * Reference count
 */
extern struct client_node *client_ref(struct client_node *client);
extern struct client_node *client_unref(struct client_node *client);
extern const int const client_refcnt(const struct client_node *client);

/*!
 * \note
 * Information of client PID
 */
extern const pid_t const client_pid(const struct client_node *client);
extern struct client_node *client_find_by_pid(pid_t pid);
extern struct client_node *client_find_by_rpc_handle(int handle);

/*!
 * \note
 * Statistics for state of client
 */
extern const int const client_count_paused(void);
extern int client_is_all_paused(void);
extern int client_count(void);

/*!
 * \note
 * For dead signal handler
 */
extern int client_deactivated_by_fault(struct client_node *client);
extern void client_reset_fault(struct client_node *client);
extern const int const client_is_faulted(const struct client_node *client);

extern const int const client_is_activated(const struct client_node *client);

/*!
 * \note
 * For other components which wants to know the state of a client
 */
extern int client_event_callback_add(struct client_node *client, enum client_event event, int (*cb)(struct client_node *, void *), void *data);
extern int client_event_callback_del(struct client_node *client, enum client_event event, int (*cb)(struct client_node *, void *), void *data);

extern int client_global_event_handler_del(enum client_global_event event_type, int (*cb)(struct client_node *, void *), void *data);
extern int client_global_event_handler_add(enum client_global_event event_type, int (*cb)(struct client_node *client, void *data), void *data);

/*!
 * \note
 * Private data set & get
 */
extern int client_set_data(struct client_node *client, const char *tag, void *data);
extern void *client_data(struct client_node *client, const char *tag);
extern void *client_del_data(struct client_node *client, const char *tag);

/*!
 * Handling the client statues
 * Paused or Resumed
 */
extern void client_paused(struct client_node *client);
extern void client_resumed(struct client_node *client);

extern int client_subscribe(struct client_node *client, const char *cluster, const char *category);
extern int client_unsubscribe(struct client_node *client, const char *cluster, const char *category);
extern int client_is_subscribed(struct client_node *client, const char *cluster, const char *category);

extern int client_init(void);
extern void client_fini(void);

extern int client_browse_list(const char *cluster, const char *category, int (*cb)(struct client_node *client, void *data), void *data);
extern int client_nr_of_subscriber(const char *cluster, const char *category);

extern int client_broadcast(struct inst_info *inst, struct packet *packet);
/* End of a file */