X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=doc%2Fapi-ref%2Fhtml%2Fd0%2Fd1e%2Fhomescreen_8c.html;h=2ea52e39e08be51998028915d1e86359b78ad4bb;hb=599de8d3f35cb0fe56c7e27591862d61944b456b;hp=8907a06c34e86c0593aaf509b6a4b222ee6422e5;hpb=26ec25e2f9271396328c208ae1a256fdf1a92c91;p=apps%2Fagl-service-homescreen.git diff --git a/doc/api-ref/html/d0/d1e/homescreen_8c.html b/doc/api-ref/html/d0/d1e/homescreen_8c.html index 8907a06..2ea52e3 100644 --- a/doc/api-ref/html/d0/d1e/homescreen_8c.html +++ b/doc/api-ref/html/d0/d1e/homescreen_8c.html @@ -5,7 +5,7 @@ -HomeScreenBinding: homescreen_service/homescreen.c File Reference +HomeScreenBinding: src/homescreen.c File Reference @@ -58,7 +58,7 @@ $(function() {
@@ -95,7 +95,7 @@ Macros   #define AFB_BINDING_VERSION   2   -#define COMMAND_EVENT_NUM   3 +#define COMMAND_EVENT_NUM   4   #define EVENT_SUBSCRIBE_ERROR_CODE   100   @@ -108,6 +108,8 @@ Functions   static void on_screen_message (struct afb_req request)   +static void on_screen_reply (struct afb_req request) +  static void subscribe (struct afb_req request)   static void unsubscribe (struct afb_req request) @@ -127,6 +129,8 @@ Variables   static struct afb_event ev_on_screen_message   +static struct afb_event ev_on_screen_reply +  static struct afb_event ev_reserved   static const char _error [] = "error" @@ -135,6 +139,8 @@ Variables   static const char _display_message [] = "display_message"   +static const char _reply_message [] = "reply_message" +  static const struct afb_verb_v2 verbs []   const struct afb_binding_v2 afbBindingV2 @@ -180,7 +186,7 @@ Variables
- +
#define COMMAND_EVENT_NUM   3#define COMMAND_EVENT_NUM   4
@@ -229,11 +235,13 @@ Variables
-

Definition at line 238 of file homescreen.c.

-
239 {
240  AFB_NOTICE("binding init");
241 
242  ev_tap_shortcut = afb_daemon_make_event(evlist[0]);
243  ev_on_screen_message = afb_daemon_make_event(evlist[1]);
244  ev_reserved = afb_daemon_make_event(evlist[2]);
245 
246  event_list[0].name = evlist[0];
247  event_list[0].event = &ev_tap_shortcut;
248 
249  event_list[1].name = evlist[1];
250  event_list[1].event = &ev_on_screen_message;
251 
252  event_list[2].name = evlist[2];
253  event_list[2].event = &ev_reserved;
254 
255  return 0;
256 }
event::event
struct afb_event * event
Definition: homescreen.c:37
-
ev_reserved
static struct afb_event ev_reserved
Definition: homescreen.c:44
-
evlist
static const char * evlist[]
Definition: hs-helper.h:33
+

Definition at line 277 of file homescreen.c.

+
278 {
279  HMI_NOTICE("homescreen-service","binding init");
280 
281  ev_tap_shortcut = afb_daemon_make_event(evlist[0]);
282  ev_on_screen_message = afb_daemon_make_event(evlist[1]);
283  ev_on_screen_reply = afb_daemon_make_event(evlist[2]);
284  ev_reserved = afb_daemon_make_event(evlist[3]);
285 
286  event_list[0].name = evlist[0];
287  event_list[0].event = &ev_tap_shortcut;
288 
289  event_list[1].name = evlist[1];
290  event_list[1].event = &ev_on_screen_message;
291 
292  event_list[2].name = evlist[2];
293  event_list[2].event = &ev_on_screen_reply;
294 
295  event_list[3].name = evlist[3];
296  event_list[3].event = &ev_reserved;
297 
298  return 0;
299 }
event::event
struct afb_event * event
Definition: homescreen.c:37
+
HMI_NOTICE
#define HMI_NOTICE(prefix, args,...)
Definition: hmi-debug.h:20
+
ev_reserved
static struct afb_event ev_reserved
Definition: homescreen.c:45
+
evlist
static const char * evlist[]
Definition: hs-helper.h:34
event::name
const char * name
Definition: homescreen.c:36
+
ev_on_screen_reply
static struct afb_event ev_on_screen_reply
Definition: homescreen.c:44
ev_on_screen_message
static struct afb_event ev_on_screen_message
Definition: homescreen.c:43
event_list
static struct event event_list[COMMAND_EVENT_NUM]
Definition: homescreen.c:40
ev_tap_shortcut
static struct afb_event ev_tap_shortcut
Definition: homescreen.c:42
@@ -263,19 +271,61 @@ Variables
-

HomeScreenのOnScreenを表示する

+

HomeScreen OnScreen message

Parameters

Request key

    -
  • display_message : 表示したい文字列
    • +
  • display_message : message for display

Return

Nothing

-

Definition at line 113 of file homescreen.c.

-
114 {
115  AFB_NOTICE("%s is called.", __FUNCTION__);
116 
117  int ret = 0;
118  const char* value = afb_req_value(request, _display_message);
119  if (value) {
120 
121  AFB_NOTICE("request params = %s.", value);
122 
123  struct json_object* push_obj = json_object_new_object();
124  hs_add_object_to_json_object_str( push_obj, 2,
125  _display_message, value);
126  afb_event_push(ev_on_screen_message, push_obj);
127  } else {
128  afb_req_fail_f(request, "failed", "called %s, Unknown palameter", __FUNCTION__);
129  return;
130  }
131 
132  // HomeScreenに返すレスポンス
133  struct json_object *res = json_object_new_object();
134  hs_add_object_to_json_object_func(res, __FUNCTION__, 2,
135  _error, ret);
136  afb_req_success(request, res, "afb_event_push event [on_screen_message]");
137 }
hs_add_object_to_json_object_str
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
Definition: hs-helper.c:110
-
_error
static const char _error[]
Definition: homescreen.c:46
+

Definition at line 114 of file homescreen.c.

+
115 {
116  HMI_NOTICE("homescreen-service","is called.");
117 
118  int ret = 0;
119  const char* value = afb_req_value(request, _display_message);
120  if (value) {
121 
122  HMI_NOTICE("homescreen-service","request params = %s.", value);
123 
124  struct json_object* push_obj = json_object_new_object();
125  hs_add_object_to_json_object_str( push_obj, 2,
126  _display_message, value);
127  afb_event_push(ev_on_screen_message, push_obj);
128  } else {
129  afb_req_fail_f(request, "failed", "called %s, Unknown palameter", __FUNCTION__);
130  return;
131  }
132 
133  // response to HomeScreen
134  struct json_object *res = json_object_new_object();
135  hs_add_object_to_json_object_func(res, __FUNCTION__, 2,
136  _error, ret);
137  afb_req_success(request, res, "afb_event_push event [on_screen_message]");
138 }
hs_add_object_to_json_object_str
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
Definition: hs-helper.c:110
+
HMI_NOTICE
#define HMI_NOTICE(prefix, args,...)
Definition: hmi-debug.h:20
+
_error
static const char _error[]
Definition: homescreen.c:47
ev_on_screen_message
static struct afb_event ev_on_screen_message
Definition: homescreen.c:43
-
_display_message
static const char _display_message[]
Definition: homescreen.c:49
+
_display_message
static const char _display_message[]
Definition: homescreen.c:50
+
hs_add_object_to_json_object_func
void hs_add_object_to_json_object_func(struct json_object *j_obj, const char *verb_name, int count,...)
Definition: hs-helper.c:125
+
+
+
+ +

◆ on_screen_reply()

+ +
+
+ + + + + +
+ + + + + + + + +
static void on_screen_reply (struct afb_req request)
+ 		+static
+
+

HomeScreen OnScreen Reply

+

Parameters

+

Request key

    +
  • reply_message : message for reply
    • +
+

Return

+

Nothing

+ +

Definition at line 151 of file homescreen.c.

+
152 {
153  HMI_NOTICE("homescreen-service","is called.");
154 
155  int ret = 0;
156  const char* value = afb_req_value(request, _reply_message);
157  if (value) {
158 
159  HMI_NOTICE("homescreen-service","request params = %s.", value);
160 
161  struct json_object* push_obj = json_object_new_object();
162  hs_add_object_to_json_object_str( push_obj, 2,
163  _reply_message, value);
164  afb_event_push(ev_on_screen_reply, push_obj);
165  } else {
166  afb_req_fail_f(request, "failed", "called %s, Unknown palameter", __FUNCTION__);
167  return;
168  }
169 
170  // response to HomeScreen
171  struct json_object *res = json_object_new_object();
172  hs_add_object_to_json_object_func(res, __FUNCTION__, 2,
173  _error, ret);
174  afb_req_success(request, res, "afb_event_push event [on_screen_reply]");
175 }
hs_add_object_to_json_object_str
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
Definition: hs-helper.c:110
+
HMI_NOTICE
#define HMI_NOTICE(prefix, args,...)
Definition: hmi-debug.h:20
+
_error
static const char _error[]
Definition: homescreen.c:47
+
ev_on_screen_reply
static struct afb_event ev_on_screen_reply
Definition: homescreen.c:44
+
_reply_message
static const char _reply_message[]
Definition: homescreen.c:51
hs_add_object_to_json_object_func
void hs_add_object_to_json_object_func(struct json_object *j_obj, const char *verb_name, int count,...)
Definition: hs-helper.c:125
@@ -314,8 +364,9 @@ Variables
-

Definition at line 258 of file homescreen.c.

-
259 {
260  AFB_NOTICE("on_event %s", event);
261 }
+

Definition at line 301 of file homescreen.c.

+
302 {
303  HMI_NOTICE("homescreen-service","on_event %s", event);
304 }
HMI_NOTICE
#define HMI_NOTICE(prefix, args,...)
Definition: hmi-debug.h:20
+
@@ -343,8 +394,9 @@ Variables
-

Definition at line 55 of file homescreen.c.

-
56 {
57  static int pingcount = 0;
58  afb_req_success_f(request, json_object_new_int(pingcount), "Ping count = %d", pingcount);
59  AFB_NOTICE("Verbosity macro at level notice invoked at ping invocation count = %d", pingcount);
60  pingcount++;
61 }
+

Definition at line 57 of file homescreen.c.

+
58 {
59  static int pingcount = 0;
60  afb_req_success_f(request, json_object_new_int(pingcount), "Ping count = %d", pingcount);
61  HMI_NOTICE("homescreen-service","Verbosity macro at level notice invoked at ping invocation count = %d", pingcount);
62  pingcount++;
63 }
HMI_NOTICE
#define HMI_NOTICE(prefix, args,...)
Definition: hmi-debug.h:20
+
@@ -370,8 +422,9 @@ Variables
-

Definition at line 232 of file homescreen.c.

-
233 {
234  AFB_NOTICE("binding preinit (was register)");
235  return 0;
236 }
+

Definition at line 271 of file homescreen.c.

+
272 {
273  HMI_NOTICE("homescreen-service","binding preinit (was register)");
274  return 0;
275 }
HMI_NOTICE
#define HMI_NOTICE(prefix, args,...)
Definition: hmi-debug.h:20
+
@@ -406,8 +459,9 @@ Variables

Nothing

Note

-

Definition at line 151 of file homescreen.c.

-
152 {
153  const char *value = afb_req_value(request, "event");
154  AFB_NOTICE("value is %s", value);
155  int ret = 0;
156  if(value) {
157  int index = hs_search_event_name_index(value);
158  if(index < 0)
159  {
160  AFB_NOTICE("dedicated event doesn't exist");
161  ret = EVENT_SUBSCRIBE_ERROR_CODE;
162  }
163  else
164  {
165  afb_req_subscribe(request, *event_list[index].event);
166  }
167  }
168  else{
169  AFB_NOTICE("Please input event name");
170  ret = EVENT_SUBSCRIBE_ERROR_CODE;
171  }
172  /*create response json object*/
173  struct json_object *res = json_object_new_object();
174  hs_add_object_to_json_object_func(res, __FUNCTION__, 2,
175  _error, ret);
176  afb_req_success_f(request, res, "homescreen binder subscribe event name [%s]", value);
177 }
_error
static const char _error[]
Definition: homescreen.c:46
+

Definition at line 189 of file homescreen.c.

+
190 {
191  const char *value = afb_req_value(request, "event");
192  HMI_NOTICE("homescreen-service","value is %s", value);
193  int ret = 0;
194  if(value) {
195  int index = hs_search_event_name_index(value);
196  if(index < 0)
197  {
198  HMI_NOTICE("homescreen-service","dedicated event doesn't exist");
199  ret = EVENT_SUBSCRIBE_ERROR_CODE;
200  }
201  else
202  {
203  afb_req_subscribe(request, *event_list[index].event);
204  }
205  }
206  else{
207  HMI_NOTICE("homescreen-service","Please input event name");
208  ret = EVENT_SUBSCRIBE_ERROR_CODE;
209  }
210  /*create response json object*/
211  struct json_object *res = json_object_new_object();
212  hs_add_object_to_json_object_func(res, __FUNCTION__, 2,
213  _error, ret);
214  afb_req_success_f(request, res, "homescreen binder subscribe event name [%s]", value);
215 }
HMI_NOTICE
#define HMI_NOTICE(prefix, args,...)
Definition: hmi-debug.h:20
+
_error
static const char _error[]
Definition: homescreen.c:47
hs_search_event_name_index
int hs_search_event_name_index(const char *value)
Definition: hs-helper.c:142
event_list
static struct event event_list[COMMAND_EVENT_NUM]
Definition: homescreen.c:40
@@ -439,18 +493,19 @@ Variables
-

HomeScreenから呼ばれる ショートカットがタップされたことをアプリケーションに通知するために使用する アプリケーションからは使用されない

+

tap_shortcut notify for homescreen When Shortcut area is tapped, notify these applciations

Parameters

Request key

Return

Nothing

-

Definition at line 76 of file homescreen.c.

-
77 {
78  AFB_NOTICE("%s is called.", __FUNCTION__);
79 
80  int ret = 0;
81  const char* value = afb_req_value(request, _application_name);
82  if (value) {
83 
84  AFB_NOTICE("request params = %s.", value);
85 
86  struct json_object* push_obj = json_object_new_object();
87  hs_add_object_to_json_object_str( push_obj, 2,
88  _application_name, value);
89  afb_event_push(ev_tap_shortcut, push_obj);
90  } else {
91  afb_req_fail_f(request, "failed", "called %s, Unknown palameter", __FUNCTION__);
92  return;
93  }
94 
95  // HomeScreenに返すレスポンス
96  struct json_object *res = json_object_new_object();
97  hs_add_object_to_json_object_func(res, __FUNCTION__, 2,
98  _error, ret);
99  afb_req_success(request, res, "afb_event_push event [tap_shortcut]");
100 }
hs_add_object_to_json_object_str
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
Definition: hs-helper.c:110
-
_application_name
static const char _application_name[]
Definition: homescreen.c:48
-
_error
static const char _error[]
Definition: homescreen.c:46
+

Definition at line 77 of file homescreen.c.

+
78 {
79  HMI_NOTICE("homescreen-service","is called.");
80 
81  int ret = 0;
82  const char* value = afb_req_value(request, _application_name);
83  if (value) {
84 
85  HMI_NOTICE("homescreen-service","request params = %s.", value);
86 
87  struct json_object* push_obj = json_object_new_object();
88  hs_add_object_to_json_object_str( push_obj, 2,
89  _application_name, value);
90  afb_event_push(ev_tap_shortcut, push_obj);
91  } else {
92  afb_req_fail_f(request, "failed", "called %s, Unknown palameter", __FUNCTION__);
93  return;
94  }
95 
96  // response to HomeScreen
97  struct json_object *res = json_object_new_object();
98  hs_add_object_to_json_object_func(res, __FUNCTION__, 2,
99  _error, ret);
100  afb_req_success(request, res, "afb_event_push event [tap_shortcut]");
101 }
hs_add_object_to_json_object_str
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
Definition: hs-helper.c:110
+
HMI_NOTICE
#define HMI_NOTICE(prefix, args,...)
Definition: hmi-debug.h:20
+
_application_name
static const char _application_name[]
Definition: homescreen.c:49
+
_error
static const char _error[]
Definition: homescreen.c:47
ev_tap_shortcut
static struct afb_event ev_tap_shortcut
Definition: homescreen.c:42
hs_add_object_to_json_object_func
void hs_add_object_to_json_object_func(struct json_object *j_obj, const char *verb_name, int count,...)
Definition: hs-helper.c:125
@@ -488,8 +543,9 @@ Variables

Nothing

Note

-

Definition at line 191 of file homescreen.c.

-
192 {
193  const char *value = afb_req_value(request, "event");
194  AFB_NOTICE("value is %s", value);
195  int ret = 0;
196  if(value) {
197  int index = hs_search_event_name_index(value);
198  if(index < 0)
199  {
200  AFB_NOTICE("dedicated event doesn't exist");
201  ret = EVENT_SUBSCRIBE_ERROR_CODE;
202  }
203  else
204  {
205  afb_req_unsubscribe(request, *event_list[index].event);
206  }
207  }
208  else{
209  AFB_NOTICE("Please input event name");
210  ret = EVENT_SUBSCRIBE_ERROR_CODE;
211  }
212  /*create response json object*/
213  struct json_object *res = json_object_new_object();
214  hs_add_object_to_json_object_func(res, __FUNCTION__, 2,
215  _error, ret);
216  afb_req_success_f(request, res, "homescreen binder unsubscribe event name [%s]", value);
217 }
_error
static const char _error[]
Definition: homescreen.c:46
+

Definition at line 229 of file homescreen.c.

+
230 {
231  const char *value = afb_req_value(request, "event");
232  HMI_NOTICE("homescreen-service","value is %s", value);
233  int ret = 0;
234  if(value) {
235  int index = hs_search_event_name_index(value);
236  if(index < 0)
237  {
238  HMI_NOTICE("homescreen-service","dedicated event doesn't exist");
239  ret = EVENT_SUBSCRIBE_ERROR_CODE;
240  }
241  else
242  {
243  afb_req_unsubscribe(request, *event_list[index].event);
244  }
245  }
246  else{
247  HMI_NOTICE("homescreen-service","Please input event name");
248  ret = EVENT_SUBSCRIBE_ERROR_CODE;
249  }
250  /*create response json object*/
251  struct json_object *res = json_object_new_object();
252  hs_add_object_to_json_object_func(res, __FUNCTION__, 2,
253  _error, ret);
254  afb_req_success_f(request, res, "homescreen binder unsubscribe event name [%s]", value);
255 }
HMI_NOTICE
#define HMI_NOTICE(prefix, args,...)
Definition: hmi-debug.h:20
+
_error
static const char _error[]
Definition: homescreen.c:47
hs_search_event_name_index
int hs_search_event_name_index(const char *value)
Definition: hs-helper.c:142
event_list
static struct event event_list[COMMAND_EVENT_NUM]
Definition: homescreen.c:40
@@ -519,7 +575,7 @@ Variables
-

Definition at line 48 of file homescreen.c.

+

Definition at line 49 of file homescreen.c.

@@ -543,7 +599,7 @@ Variables
-

Definition at line 49 of file homescreen.c.

+

Definition at line 50 of file homescreen.c.

@@ -567,7 +623,31 @@ Variables
-

Definition at line 46 of file homescreen.c.

+

Definition at line 47 of file homescreen.c.

+ +
+ + +

◆ _reply_message

+ +
+
+ + + + + +
+ + + + +
const char _reply_message[] = "reply_message"
+ 		+static
+
+ +

Definition at line 51 of file homescreen.c.

@@ -582,12 +662,12 @@ Variables
-Initial value:
= {
.api = "homescreen",
.specification = NULL,
.verbs = verbs,
.preinit = preinit,
.init = init,
.onevent = onevent
}
preinit
static int preinit()
Definition: homescreen.c:232
-
onevent
static void onevent(const char *event, struct json_object *object)
Definition: homescreen.c:258
-
init
static int init()
Definition: homescreen.c:238
-
verbs
static const struct afb_verb_v2 verbs[]
Definition: homescreen.c:222
+Initial value:
= {
.api = "homescreen",
.specification = NULL,
.verbs = verbs,
.preinit = preinit,
.init = init,
.onevent = onevent
}
preinit
static int preinit()
Definition: homescreen.c:271
+
onevent
static void onevent(const char *event, struct json_object *object)
Definition: homescreen.c:301
+
init
static int init()
Definition: homescreen.c:277
+
verbs
static const struct afb_verb_v2 verbs[]
Definition: homescreen.c:260
-

Definition at line 263 of file homescreen.c.

+

Definition at line 306 of file homescreen.c.

@@ -613,6 +693,30 @@ Variables

Definition at line 43 of file homescreen.c.

+ + + +

◆ ev_on_screen_reply

+ +
+
+ + + + + +
+ + + + +
struct afb_event ev_on_screen_reply
+ 		+static
+
+ +

Definition at line 44 of file homescreen.c.

+
@@ -635,7 +739,7 @@ Variables
-

Definition at line 44 of file homescreen.c.

+

Definition at line 45 of file homescreen.c.

@@ -706,13 +810,14 @@ Variables
-Initial value:
= {
{ .verb = "ping", .session = AFB_SESSION_NONE, .callback = pingSample, .auth = NULL },
{ .verb = "tap_shortcut", .session = AFB_SESSION_NONE, .callback = tap_shortcut, .auth = NULL },
{ .verb = "on_screen_message", .session = AFB_SESSION_NONE, .callback = on_screen_message, .auth = NULL },
{ .verb = "subscribe", .session = AFB_SESSION_NONE, .callback = subscribe, .auth = NULL },
{ .verb = "unsubscribe", .session = AFB_SESSION_NONE, .callback = unsubscribe, .auth = NULL },
{NULL }
}
tap_shortcut
static void tap_shortcut(struct afb_req request)
Definition: homescreen.c:76
-
pingSample
static void pingSample(struct afb_req request)
Definition: homescreen.c:55
-
unsubscribe
static void unsubscribe(struct afb_req request)
Definition: homescreen.c:191
-
on_screen_message
static void on_screen_message(struct afb_req request)
Definition: homescreen.c:113
-
subscribe
static void subscribe(struct afb_req request)
Definition: homescreen.c:151
+Initial value:
= {
{ .verb = "ping", .session = AFB_SESSION_NONE, .callback = pingSample, .auth = NULL },
{ .verb = "tap_shortcut", .session = AFB_SESSION_NONE, .callback = tap_shortcut, .auth = NULL },
{ .verb = "on_screen_message", .session = AFB_SESSION_NONE, .callback = on_screen_message, .auth = NULL },
{ .verb = "on_screen_reply", .session = AFB_SESSION_NONE, .callback = on_screen_reply, .auth = NULL },
{ .verb = "subscribe", .session = AFB_SESSION_NONE, .callback = subscribe, .auth = NULL },
{ .verb = "unsubscribe", .session = AFB_SESSION_NONE, .callback = unsubscribe, .auth = NULL },
{NULL }
}
tap_shortcut
static void tap_shortcut(struct afb_req request)
Definition: homescreen.c:77
+
pingSample
static void pingSample(struct afb_req request)
Definition: homescreen.c:57
+
on_screen_reply
static void on_screen_reply(struct afb_req request)
Definition: homescreen.c:151
+
unsubscribe
static void unsubscribe(struct afb_req request)
Definition: homescreen.c:229
+
on_screen_message
static void on_screen_message(struct afb_req request)
Definition: homescreen.c:114
+
subscribe
static void subscribe(struct afb_req request)
Definition: homescreen.c:189
-

Definition at line 222 of file homescreen.c.

+

Definition at line 260 of file homescreen.c.