diff options
Diffstat (limited to 'doc/api-ref/html/de/dd0/class_lib_home_screen.html')
| -rw-r--r-- | doc/api-ref/html/de/dd0/class_lib_home_screen.html | 835 |
1 files changed, 835 insertions, 0 deletions
diff --git a/doc/api-ref/html/de/dd0/class_lib_home_screen.html b/doc/api-ref/html/de/dd0/class_lib_home_screen.html new file mode 100644 index 0000000..42548a6 --- /dev/null +++ b/doc/api-ref/html/de/dd0/class_lib_home_screen.html @@ -0,0 +1,835 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>HomeScreenBinding: LibHomeScreen Class Reference</title> +<link href="../../tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="../../jquery.js"></script> +<script type="text/javascript" src="../../dynsections.js"></script> +<link href="../../search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="../../search/searchdata.js"></script> +<script type="text/javascript" src="../../search/search.js"></script> +<link href="../../doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">HomeScreenBinding + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "../../search",false,'Search'); +</script> +<script type="text/javascript" src="../../menudata.js"></script> +<script type="text/javascript" src="../../menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('../../',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-types">Public Types</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-static-attribs">Static Public Attributes</a> | +<a href="../../d7/df4/class_lib_home_screen-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">LibHomeScreen Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="../../df/d43/libhomescreen_8hpp_source.html">libhomescreen.hpp</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:a82616c91ac211d2ad08e709b524bf154"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154">EventType</a> { <a class="el" href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154a4b0a82d501e4db5fbfe25c254c92896f">Event_TapShortcut</a> = 1, +<a class="el" href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154aea56fa32a124a8ddcbea127755280a1d">Event_OnScreenMessage</a> + }</td></tr> +<tr class="separator:a82616c91ac211d2ad08e709b524bf154"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae99dee1e03d494d59d26c9f17078e01f"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#ae99dee1e03d494d59d26c9f17078e01f">handler_func</a> = std::function< void(const char *)></td></tr> +<tr class="separator:ae99dee1e03d494d59d26c9f17078e01f"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a724bd949c4154fad041f96a15ef0f5dc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a724bd949c4154fad041f96a15ef0f5dc">LibHomeScreen</a> ()</td></tr> +<tr class="separator:a724bd949c4154fad041f96a15ef0f5dc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a249902aebf71a5383ca8ec6ae558d095"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a249902aebf71a5383ca8ec6ae558d095">~LibHomeScreen</a> ()</td></tr> +<tr class="separator:a249902aebf71a5383ca8ec6ae558d095"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0fff2f703c8ce184eb9edd133e0f4137"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a0fff2f703c8ce184eb9edd133e0f4137">LibHomeScreen</a> (const <a class="el" href="../../de/dd0/class_lib_home_screen.html">LibHomeScreen</a> &)=delete</td></tr> +<tr class="separator:a0fff2f703c8ce184eb9edd133e0f4137"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a23bc17798453cfca50904562736f6b25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../de/dd0/class_lib_home_screen.html">LibHomeScreen</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a23bc17798453cfca50904562736f6b25">operator=</a> (const <a class="el" href="../../de/dd0/class_lib_home_screen.html">LibHomeScreen</a> &)=delete</td></tr> +<tr class="separator:a23bc17798453cfca50904562736f6b25"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6a57b573cc767725762ba9beab032220"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a6a57b573cc767725762ba9beab032220">init</a> (const int port, const std::string &token)</td></tr> +<tr class="separator:a6a57b573cc767725762ba9beab032220"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a32d3282898d0f04151c24b4103511e00"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a32d3282898d0f04151c24b4103511e00">runEventloop</a> ()</td></tr> +<tr class="separator:a32d3282898d0f04151c24b4103511e00"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afb571c9577087b47065eb23e7fdbc903"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#afb571c9577087b47065eb23e7fdbc903">tapShortcut</a> (const char *application_name)</td></tr> +<tr class="separator:afb571c9577087b47065eb23e7fdbc903"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac336482036a72b51a822725f1929523c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#ac336482036a72b51a822725f1929523c">onScreenMessage</a> (const char *display_message)</td></tr> +<tr class="separator:ac336482036a72b51a822725f1929523c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab1b0e08bf35415de9064afed899e9f85"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#ab1b0e08bf35415de9064afed899e9f85">set_event_handler</a> (enum <a class="el" href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154">EventType</a> et, <a class="el" href="../../de/dd0/class_lib_home_screen.html#ae99dee1e03d494d59d26c9f17078e01f">handler_func</a> f)</td></tr> +<tr class="separator:ab1b0e08bf35415de9064afed899e9f85"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2789e8a5372202cc36f48e71dbb9b7cf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a2789e8a5372202cc36f48e71dbb9b7cf">registerCallback</a> (void(*event_cb)(const std::string &<a class="el" href="../../df/d7d/structevent.html">event</a>, struct json_object *event_contents), void(*reply_cb)(struct json_object *reply_contents), void(*hangup_cb)(void)=nullptr)</td></tr> +<tr class="separator:a2789e8a5372202cc36f48e71dbb9b7cf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a527b49dcfe581be6275d0eb2236ba37f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a527b49dcfe581be6275d0eb2236ba37f">call</a> (const std::string &verb, struct json_object *arg)</td></tr> +<tr class="separator:a527b49dcfe581be6275d0eb2236ba37f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab5e8e8ab7d53e0f114e9e907fcbb7643"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#ab5e8e8ab7d53e0f114e9e907fcbb7643">call</a> (const char *verb, struct json_object *arg)</td></tr> +<tr class="separator:ab5e8e8ab7d53e0f114e9e907fcbb7643"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa4c189807b75d070f567967f0d690738"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#aa4c189807b75d070f567967f0d690738">subscribe</a> (const std::string &event_name)</td></tr> +<tr class="separator:aa4c189807b75d070f567967f0d690738"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aac03a45cbd453ba69ddb00c1016930a6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#aac03a45cbd453ba69ddb00c1016930a6">unsubscribe</a> (const std::string &event_name)</td></tr> +<tr class="separator:aac03a45cbd453ba69ddb00c1016930a6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab1c1fa69f24b981e824dd9fb810c4b74"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#ab1c1fa69f24b981e824dd9fb810c4b74">on_hangup</a> (void *closure, struct afb_wsj1 *wsj)</td></tr> +<tr class="separator:ab1c1fa69f24b981e824dd9fb810c4b74"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a608638eb87b2772a3dcc92d8ca8f3596"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a608638eb87b2772a3dcc92d8ca8f3596">on_call</a> (void *closure, const char *api, const char *verb, struct afb_wsj1_msg *msg)</td></tr> +<tr class="separator:a608638eb87b2772a3dcc92d8ca8f3596"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9c4885b51b43ab24a548d49fb3ab2de3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a9c4885b51b43ab24a548d49fb3ab2de3">on_event</a> (void *closure, const char *<a class="el" href="../../df/d7d/structevent.html">event</a>, struct afb_wsj1_msg *msg)</td></tr> +<tr class="separator:a9c4885b51b43ab24a548d49fb3ab2de3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a248d9648c6186287a7632ec1c75fc9c5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a248d9648c6186287a7632ec1c75fc9c5">on_reply</a> (void *closure, struct afb_wsj1_msg *msg)</td></tr> +<tr class="separator:a248d9648c6186287a7632ec1c75fc9c5"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> +Static Public Attributes</h2></td></tr> +<tr class="memitem:a5593ff5ac78f6495ccb649904cf0ab08"><td class="memItemLeft" align="right" valign="top">static const std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a5593ff5ac78f6495ccb649904cf0ab08">api_list</a></td></tr> +<tr class="separator:a5593ff5ac78f6495ccb649904cf0ab08"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6a6d8a4d33a006a08652e7377a4c29e9"><td class="memItemLeft" align="right" valign="top">static const std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd0/class_lib_home_screen.html#a6a6d8a4d33a006a08652e7377a4c29e9">event_list</a></td></tr> +<tr class="separator:a6a6d8a4d33a006a08652e7377a4c29e9"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"> +<p class="definition">Definition at line <a class="el" href="../../df/d43/libhomescreen_8hpp_source.html#l00032">32</a> of file <a class="el" href="../../df/d43/libhomescreen_8hpp_source.html">libhomescreen.hpp</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="ae99dee1e03d494d59d26c9f17078e01f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae99dee1e03d494d59d26c9f17078e01f">◆ </a></span>handler_func</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">using <a class="el" href="../../de/dd0/class_lib_home_screen.html#ae99dee1e03d494d59d26c9f17078e01f">LibHomeScreen::handler_func</a> = std::function<void(const char*)></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="../../df/d43/libhomescreen_8hpp_source.html#l00041">41</a> of file <a class="el" href="../../df/d43/libhomescreen_8hpp_source.html">libhomescreen.hpp</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Enumeration Documentation</h2> +<a id="a82616c91ac211d2ad08e709b524bf154"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a82616c91ac211d2ad08e709b524bf154">◆ </a></span>EventType</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154">LibHomeScreen::EventType</a></td> + </tr> + </table> +</div><div class="memdoc"> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a82616c91ac211d2ad08e709b524bf154a4b0a82d501e4db5fbfe25c254c92896f"></a>Event_TapShortcut </td><td class="fielddoc"></td></tr> +<tr><td class="fieldname"><a id="a82616c91ac211d2ad08e709b524bf154aea56fa32a124a8ddcbea127755280a1d"></a>Event_OnScreenMessage </td><td class="fielddoc"></td></tr> +</table> + +<p class="definition">Definition at line <a class="el" href="../../df/d43/libhomescreen_8hpp_source.html#l00043">43</a> of file <a class="el" href="../../df/d43/libhomescreen_8hpp_source.html">libhomescreen.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154a4b0a82d501e4db5fbfe25c254c92896f">Event_TapShortcut</a> = 1,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154aea56fa32a124a8ddcbea127755280a1d">Event_OnScreenMessage</a></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  };</div><div class="ttc" id="class_lib_home_screen_html_a82616c91ac211d2ad08e709b524bf154aea56fa32a124a8ddcbea127755280a1d"><div class="ttname"><a href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154aea56fa32a124a8ddcbea127755280a1d">LibHomeScreen::Event_OnScreenMessage</a></div><div class="ttdef"><b>Definition:</b> <a href="../../df/d43/libhomescreen_8hpp_source.html#l00045">libhomescreen.hpp:45</a></div></div> +<div class="ttc" id="class_lib_home_screen_html_a82616c91ac211d2ad08e709b524bf154a4b0a82d501e4db5fbfe25c254c92896f"><div class="ttname"><a href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154a4b0a82d501e4db5fbfe25c254c92896f">LibHomeScreen::Event_TapShortcut</a></div><div class="ttdef"><b>Definition:</b> <a href="../../df/d43/libhomescreen_8hpp_source.html#l00044">libhomescreen.hpp:44</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a724bd949c4154fad041f96a15ef0f5dc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a724bd949c4154fad041f96a15ef0f5dc">◆ </a></span>LibHomeScreen() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">LibHomeScreen::LibHomeScreen </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>constructor </p> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00085">85</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a249902aebf71a5383ca8ec6ae558d095"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a249902aebf71a5383ca8ec6ae558d095">◆ </a></span>~LibHomeScreen()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">LibHomeScreen::~LibHomeScreen </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>destructor </p> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00093">93</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">if</span>(mploop)</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  {</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  sd_event_unref(mploop);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  }</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">if</span>(sp_websock != NULL)</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  {</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  free(sp_websock);</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  }</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a0fff2f703c8ce184eb9edd133e0f4137"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0fff2f703c8ce184eb9edd133e0f4137">◆ </a></span>LibHomeScreen() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">LibHomeScreen::LibHomeScreen </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="../../de/dd0/class_lib_home_screen.html">LibHomeScreen</a> & </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">delete</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a527b49dcfe581be6275d0eb2236ba37f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a527b49dcfe581be6275d0eb2236ba37f">◆ </a></span>call() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int LibHomeScreen::call </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>verb</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct json_object * </td> + <td class="paramname"><em>arg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="ab5e8e8ab7d53e0f114e9e907fcbb7643"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab5e8e8ab7d53e0f114e9e907fcbb7643">◆ </a></span>call() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int LibHomeScreen::call </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>verb</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct json_object * </td> + <td class="paramname"><em>arg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>This function calls the API of HomeScreen via WebSocket This function is overload function of "call"</p> +<h4>Parameters</h4> +<ul> +<li>verb [in] : This argument should be specified to the API name (e.g. "tap_shortcut")</li> +<li>arg [in] : This argument should be specified to the argument of API. And this argument expects JSON object</li> +</ul> +<h4>Return</h4> +<ul> +<li>Returns 0 on success or -1 in case of error.</li> +</ul> +<h4>Note</h4> +<p>To call HomeScreen's APIs, the application should set its function name, arguments to JSON format. </p> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00369">369</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00370"></a><span class="lineno"> 370</span> {</div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  <span class="keywordtype">int</span> ret;</div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  <span class="keywordflow">if</span>(!sp_websock)</div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  {</div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span>  <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span>  }</div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span>  <span class="keywordflow">if</span> (!<a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a7a2176c3d71fec0f09dcb2aa0866b17e">has_verb</a>(<span class="keywordtype">string</span>(verb)))</div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span>  {</div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span>  <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a>(<span class="stringliteral">"verb doesn't exit"</span>);</div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span>  <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span>  }</div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  ret = afb_wsj1_call_j(sp_websock, <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a1e2d6e77dd8f0162f830058579eab42f">API</a>, verb, arg, <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a7778933bffa862c63fa0a1b8219faa8b">_on_reply_static</a>, <span class="keyword">this</span>);</div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span>  <span class="keywordflow">if</span> (ret < 0) {</div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span>  <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a>(<span class="stringliteral">"Failed to call verb:%s"</span>,verb);</div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  }</div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span> }</div><div class="ttc" id="libhomescreen_8cpp_html_a1e2d6e77dd8f0162f830058579eab42f"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a1e2d6e77dd8f0162f830058579eab42f">API</a></div><div class="ttdeci">static const char API[]</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00040">libhomescreen.cpp:40</a></div></div> +<div class="ttc" id="libhomescreen_8cpp_html_a797aa3053bd6a29819d44f8fad8a5eca"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a></div><div class="ttdeci">#define ELOG(args,...)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00032">libhomescreen.cpp:32</a></div></div> +<div class="ttc" id="libhomescreen_8cpp_html_a7a2176c3d71fec0f09dcb2aa0866b17e"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a7a2176c3d71fec0f09dcb2aa0866b17e">has_verb</a></div><div class="ttdeci">static bool has_verb(const string &verb)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00557">libhomescreen.cpp:557</a></div></div> +<div class="ttc" id="libhomescreen_8cpp_html_a7778933bffa862c63fa0a1b8219faa8b"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a7778933bffa862c63fa0a1b8219faa8b">_on_reply_static</a></div><div class="ttdeci">static void _on_reply_static(void *closure, struct afb_wsj1_msg *msg)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00076">libhomescreen.cpp:76</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a6a57b573cc767725762ba9beab032220"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6a57b573cc767725762ba9beab032220">◆ </a></span>init()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int LibHomeScreen::init </td> + <td>(</td> + <td class="paramtype">const int </td> + <td class="paramname"><em>port</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>token</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>This function is initializer</p> +<h4>Parameters</h4> +<ul> +<li>port [in] : This argument should be specified to the port number to be used for websocket</li> +<li>token [in] : This argument should be specified to the token to be used for websocket</li> +</ul> +<h4>Return</h4> +<p>Nothing</p> +<h4>Note</h4> +<p>Use this constructor </p> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00119">119</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> {</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">int</span> ret = 0;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">if</span>(port > 0 && token.size() > 0)</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  {</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  mport = port;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  mtoken = token;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  }</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  {</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a>(<span class="stringliteral">"port and token should be > 0, Initial port and token uses."</span>);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  }</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  ret = initialize_websocket();</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordflow">if</span>(ret != 0 )</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  {</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a>(<span class="stringliteral">"Failed to initialize websocket"</span>);</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  }</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordflow">else</span>{</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a4e42b2f5af2174dd24f958351becf63d">DLOG</a>(<span class="stringliteral">"Initialized"</span>);</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  }</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> }</div><div class="ttc" id="libhomescreen_8cpp_html_a4e42b2f5af2174dd24f958351becf63d"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a4e42b2f5af2174dd24f958351becf63d">DLOG</a></div><div class="ttdeci">#define DLOG(args,...)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00033">libhomescreen.cpp:33</a></div></div> +<div class="ttc" id="libhomescreen_8cpp_html_a797aa3053bd6a29819d44f8fad8a5eca"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a></div><div class="ttdeci">#define ELOG(args,...)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00032">libhomescreen.cpp:32</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a608638eb87b2772a3dcc92d8ca8f3596"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a608638eb87b2772a3dcc92d8ca8f3596">◆ </a></span>on_call()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void LibHomeScreen::on_call </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"><em>closure</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>api</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>verb</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct afb_wsj1_msg * </td> + <td class="paramname"><em>msg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00457">457</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00458"></a><span class="lineno"> 458</span> {</div><div class="line"><a name="l00459"></a><span class="lineno"> 459</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a9c4885b51b43ab24a548d49fb3ab2de3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9c4885b51b43ab24a548d49fb3ab2de3">◆ </a></span>on_event()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void LibHomeScreen::on_event </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"><em>closure</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>event</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct afb_wsj1_msg * </td> + <td class="paramname"><em>msg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00467">467</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00468"></a><span class="lineno"> 468</span> {</div><div class="line"><a name="l00469"></a><span class="lineno"> 469</span>  cout << <span class="stringliteral">"[libhomescreen on_event]: "</span> << <span class="keyword">event</span> << <span class="stringliteral">" ("</span> << afb_wsj1_msg_object_s(msg) << <span class="stringliteral">")"</span> << endl;</div><div class="line"><a name="l00470"></a><span class="lineno"> 470</span> </div><div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  <span class="keywordflow">if</span> (strstr(<a class="code" href="../../df/d7d/structevent.html">event</a>, <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a1e2d6e77dd8f0162f830058579eab42f">API</a>) == NULL) {</div><div class="line"><a name="l00472"></a><span class="lineno"> 472</span>  <span class="keywordflow">return</span>;</div><div class="line"><a name="l00473"></a><span class="lineno"> 473</span>  }</div><div class="line"><a name="l00474"></a><span class="lineno"> 474</span> </div><div class="line"><a name="l00475"></a><span class="lineno"> 475</span>  <span class="keyword">struct </span>json_object* ev_contents = afb_wsj1_msg_object_j(msg);</div><div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  <span class="keyword">struct </span>json_object *json_data = json_object_object_get(ev_contents, <span class="stringliteral">"data"</span>);</div><div class="line"><a name="l00477"></a><span class="lineno"> 477</span> </div><div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  <span class="keywordflow">if</span>(onEvent != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  {</div><div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> ev(<a class="code" href="../../df/d7d/structevent.html">event</a>);</div><div class="line"><a name="l00481"></a><span class="lineno"> 481</span>  onEvent(ev, ev_contents);</div><div class="line"><a name="l00482"></a><span class="lineno"> 482</span>  }</div><div class="line"><a name="l00483"></a><span class="lineno"> 483</span> </div><div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* event_only = strchr(<a class="code" href="../../df/d7d/structevent.html">event</a>, <span class="charliteral">'/'</span>);</div><div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  <span class="keywordflow">if</span> (event_only != <span class="keyword">nullptr</span>) {</div><div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  event_only = event_only + 1;</div><div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  }</div><div class="line"><a name="l00488"></a><span class="lineno"> 488</span> </div><div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  <span class="keywordflow">if</span> (strcasecmp(event_only, <a class="code" href="../../de/dd0/class_lib_home_screen.html#a6a6d8a4d33a006a08652e7377a4c29e9">LibHomeScreen::event_list</a>[0].c_str()) == 0) {</div><div class="line"><a name="l00490"></a><span class="lineno"> 490</span>  <span class="keyword">auto</span> i = this->handlers.find(<a class="code" href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154a4b0a82d501e4db5fbfe25c254c92896f">Event_TapShortcut</a>);</div><div class="line"><a name="l00491"></a><span class="lineno"> 491</span> </div><div class="line"><a name="l00492"></a><span class="lineno"> 492</span>  <span class="keyword">struct </span>json_object *json_application_name = json_object_object_get(json_data, <span class="stringliteral">"application_name"</span>);</div><div class="line"><a name="l00493"></a><span class="lineno"> 493</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* application_name = json_object_get_string(json_application_name);</div><div class="line"><a name="l00494"></a><span class="lineno"> 494</span> </div><div class="line"><a name="l00495"></a><span class="lineno"> 495</span>  <span class="keywordflow">if</span> ( i != this->handlers.end() ) {</div><div class="line"><a name="l00496"></a><span class="lineno"> 496</span>  i->second(application_name);</div><div class="line"><a name="l00497"></a><span class="lineno"> 497</span>  }</div><div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  }</div><div class="line"><a name="l00499"></a><span class="lineno"> 499</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (strcasecmp(event_only, <a class="code" href="../../de/dd0/class_lib_home_screen.html#a6a6d8a4d33a006a08652e7377a4c29e9">LibHomeScreen::event_list</a>[1].c_str()) == 0) {</div><div class="line"><a name="l00500"></a><span class="lineno"> 500</span> </div><div class="line"><a name="l00501"></a><span class="lineno"> 501</span>  <span class="keyword">auto</span> i = this->handlers.find(<a class="code" href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154aea56fa32a124a8ddcbea127755280a1d">Event_OnScreenMessage</a>);</div><div class="line"><a name="l00502"></a><span class="lineno"> 502</span> </div><div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  <span class="keyword">struct </span>json_object *json_display_message = json_object_object_get(json_data, <span class="stringliteral">"display_message"</span>);</div><div class="line"><a name="l00504"></a><span class="lineno"> 504</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* display_message = json_object_get_string(json_display_message);</div><div class="line"><a name="l00505"></a><span class="lineno"> 505</span> </div><div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  <span class="keywordflow">if</span> ( i != this->handlers.end() ) {</div><div class="line"><a name="l00507"></a><span class="lineno"> 507</span>  i->second(display_message);</div><div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  }</div><div class="line"><a name="l00509"></a><span class="lineno"> 509</span> </div><div class="line"><a name="l00510"></a><span class="lineno"> 510</span>  }</div><div class="line"><a name="l00511"></a><span class="lineno"> 511</span> </div><div class="line"><a name="l00512"></a><span class="lineno"> 512</span>  json_object_put(ev_contents);</div><div class="line"><a name="l00513"></a><span class="lineno"> 513</span> }</div><div class="ttc" id="structevent_html"><div class="ttname"><a href="../../df/d7d/structevent.html">event</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d1e/homescreen_8c_source.html#l00035">homescreen.c:35</a></div></div> +<div class="ttc" id="libhomescreen_8cpp_html_a1e2d6e77dd8f0162f830058579eab42f"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a1e2d6e77dd8f0162f830058579eab42f">API</a></div><div class="ttdeci">static const char API[]</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00040">libhomescreen.cpp:40</a></div></div> +<div class="ttc" id="class_lib_home_screen_html_a82616c91ac211d2ad08e709b524bf154aea56fa32a124a8ddcbea127755280a1d"><div class="ttname"><a href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154aea56fa32a124a8ddcbea127755280a1d">LibHomeScreen::Event_OnScreenMessage</a></div><div class="ttdef"><b>Definition:</b> <a href="../../df/d43/libhomescreen_8hpp_source.html#l00045">libhomescreen.hpp:45</a></div></div> +<div class="ttc" id="class_lib_home_screen_html_a6a6d8a4d33a006a08652e7377a4c29e9"><div class="ttname"><a href="../../de/dd0/class_lib_home_screen.html#a6a6d8a4d33a006a08652e7377a4c29e9">LibHomeScreen::event_list</a></div><div class="ttdeci">static const std::vector< std::string > event_list</div><div class="ttdef"><b>Definition:</b> <a href="../../df/d43/libhomescreen_8hpp_source.html#l00049">libhomescreen.hpp:49</a></div></div> +<div class="ttc" id="class_lib_home_screen_html_a82616c91ac211d2ad08e709b524bf154a4b0a82d501e4db5fbfe25c254c92896f"><div class="ttname"><a href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154a4b0a82d501e4db5fbfe25c254c92896f">LibHomeScreen::Event_TapShortcut</a></div><div class="ttdef"><b>Definition:</b> <a href="../../df/d43/libhomescreen_8hpp_source.html#l00044">libhomescreen.hpp:44</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="ab1c1fa69f24b981e824dd9fb810c4b74"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab1c1fa69f24b981e824dd9fb810c4b74">◆ </a></span>on_hangup()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void LibHomeScreen::on_hangup </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"><em>closure</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct afb_wsj1 * </td> + <td class="paramname"><em>wsj</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00448">448</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00449"></a><span class="lineno"> 449</span> {</div><div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a4e42b2f5af2174dd24f958351becf63d">DLOG</a>(<span class="stringliteral">"%s called"</span>, __FUNCTION__);</div><div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  <span class="keywordflow">if</span>(onHangup != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  {</div><div class="line"><a name="l00453"></a><span class="lineno"> 453</span>  onHangup();</div><div class="line"><a name="l00454"></a><span class="lineno"> 454</span>  }</div><div class="line"><a name="l00455"></a><span class="lineno"> 455</span> }</div><div class="ttc" id="libhomescreen_8cpp_html_a4e42b2f5af2174dd24f958351becf63d"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a4e42b2f5af2174dd24f958351becf63d">DLOG</a></div><div class="ttdeci">#define DLOG(args,...)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00033">libhomescreen.cpp:33</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a248d9648c6186287a7632ec1c75fc9c5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a248d9648c6186287a7632ec1c75fc9c5">◆ </a></span>on_reply()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void LibHomeScreen::on_reply </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"><em>closure</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct afb_wsj1_msg * </td> + <td class="paramname"><em>msg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>msg is like ({"response":{"verb":"subscribe","error":0},"jtype":"afb-reply","request":{"status":"success","info":"homescreen binder subscribe event name [on_screen_message]"}}) msg is like ({"response":{"verb":"tap_shortcut","error":0},"jtype":"afb-reply","request":{"status":"success","info":"afb_event_push event [tap_shortcut]"}}) </p> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00519">519</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00520"></a><span class="lineno"> 520</span> {</div><div class="line"><a name="l00521"></a><span class="lineno"> 521</span>  cout << <span class="stringliteral">"[libhomescreen on_reply]: "</span> << <span class="stringliteral">" ("</span> << afb_wsj1_msg_object_s(msg) << <span class="stringliteral">")"</span> << endl;</div><div class="line"><a name="l00522"></a><span class="lineno"> 522</span>  <span class="keywordflow">if</span>(onReply != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00523"></a><span class="lineno"> 523</span>  {</div><div class="line"><a name="l00524"></a><span class="lineno"> 524</span>  <span class="keyword">struct </span>json_object* reply = afb_wsj1_msg_object_j(msg);</div><div class="line"><a name="l00525"></a><span class="lineno"> 525</span>  onReply(reply);</div><div class="line"><a name="l00526"></a><span class="lineno"> 526</span> </div><div class="line"><a name="l00527"></a><span class="lineno"> 527</span>  json_object_put(reply);</div><div class="line"><a name="l00528"></a><span class="lineno"> 528</span>  }</div><div class="line"><a name="l00529"></a><span class="lineno"> 529</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="ac336482036a72b51a822725f1929523c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac336482036a72b51a822725f1929523c">◆ </a></span>onScreenMessage()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int LibHomeScreen::onScreenMessage </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>display_message</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>HomeScreenアプリに表示するメッセージイベントの発行</p> +<p>各アプリからHomeScreenアプリケーションのOnScreenに表示するイベントを発行する</p> +<h4>Parameters</h4> +<ul> +<li>display_message [in] : 表示するメッセージ</li> +</ul> +<h4>Return</h4> +<ul> +<li>Returns 0 on success or -1 in case of error. </li> +</ul> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00280">280</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> {</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  <span class="keywordflow">if</span>(!sp_websock)</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  {</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  }</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> </div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  <span class="keyword">struct </span>json_object* j_obj = json_object_new_object();</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  <span class="keyword">struct </span>json_object* val = json_object_new_string(display_message);</div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  json_object_object_add(j_obj, <span class="stringliteral">"display_message"</span>, val);</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  <span class="keywordflow">return</span> this-><a class="code" href="../../de/dd0/class_lib_home_screen.html#a527b49dcfe581be6275d0eb2236ba37f">call</a>(<span class="stringliteral">"on_screen_message"</span>, j_obj);</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> }</div><div class="ttc" id="class_lib_home_screen_html_a527b49dcfe581be6275d0eb2236ba37f"><div class="ttname"><a href="../../de/dd0/class_lib_home_screen.html#a527b49dcfe581be6275d0eb2236ba37f">LibHomeScreen::call</a></div><div class="ttdeci">int call(const std::string &verb, struct json_object *arg)</div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a23bc17798453cfca50904562736f6b25"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a23bc17798453cfca50904562736f6b25">◆ </a></span>operator=()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="../../de/dd0/class_lib_home_screen.html">LibHomeScreen</a>& LibHomeScreen::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="../../de/dd0/class_lib_home_screen.html">LibHomeScreen</a> & </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">delete</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a2789e8a5372202cc36f48e71dbb9b7cf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2789e8a5372202cc36f48e71dbb9b7cf">◆ </a></span>registerCallback()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void LibHomeScreen::registerCallback </td> + <td>(</td> + <td class="paramtype">void(*)(const std::string &<a class="el" href="../../df/d7d/structevent.html">event</a>, struct json_object *event_contents) </td> + <td class="paramname"><em>event_cb</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void(*)(struct json_object *reply_contents) </td> + <td class="paramname"><em>reply_cb</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void(*)(void) </td> + <td class="paramname"><em>hangup_cb</em> = <code>nullptr</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>This function register callback function for reply/event message from home screen</p> +<h4>Parameters</h4> +<ul> +<li>event_cb [in] : This argument should be specified to the callback for subscribed event</li> +<li>reply_cb [in] : This argument should be specified to the reply callback for call function</li> +</ul> +<h4>Return</h4> +<p>Nothing</p> +<h4>Note</h4> +<p>Event callback is invoked by home screen for event you subscribed. If you would like to get event, please call subscribe function before/after this function </p> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00158">158</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> {</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  onEvent = event_cb;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  onReply = reply_cb;</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  onHangup = hangup_cb;</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a32d3282898d0f04151c24b4103511e00"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a32d3282898d0f04151c24b4103511e00">◆ </a></span>runEventloop()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int LibHomeScreen::runEventloop </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>This function start receiving the reply/event message from home screen</p> +<h4>Parameters</h4> +<p>Nothing</p> +<h4>Return</h4> +<ul> +<li>Returns thread_id on success or -1 in case of error.</li> +</ul> +<h4>Note</h4> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00224">224</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> {</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keywordflow">if</span>(mploop && sp_websock)</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  {</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  pthread_t thread_id;</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="keywordtype">int</span> ret = pthread_create(&thread_id, NULL, <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#aa73353e1bf62c68b6b0aba7a1e4e275e">event_loop_run</a>, mploop);</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="keywordflow">if</span>(ret != 0)</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  {</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a>(<span class="stringliteral">"Cannot run eventloop due to error:%d"</span>, errno);</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  }</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keywordflow">return</span> thread_id;</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  }</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  {</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a>(<span class="stringliteral">"Connecting is not established yet"</span>);</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  }</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> }</div><div class="ttc" id="libhomescreen_8cpp_html_a797aa3053bd6a29819d44f8fad8a5eca"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a></div><div class="ttdeci">#define ELOG(args,...)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00032">libhomescreen.cpp:32</a></div></div> +<div class="ttc" id="libhomescreen_8cpp_html_aa73353e1bf62c68b6b0aba7a1e4e275e"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#aa73353e1bf62c68b6b0aba7a1e4e275e">event_loop_run</a></div><div class="ttdeci">static void * event_loop_run(void *args)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00204">libhomescreen.cpp:204</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="ab1b0e08bf35415de9064afed899e9f85"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab1b0e08bf35415de9064afed899e9f85">◆ </a></span>set_event_handler()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void LibHomeScreen::set_event_handler </td> + <td>(</td> + <td class="paramtype">enum <a class="el" href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154">EventType</a> </td> + <td class="paramname"><em>et</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="../../de/dd0/class_lib_home_screen.html#ae99dee1e03d494d59d26c9f17078e01f">handler_func</a> </td> + <td class="paramname"><em>f</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>イベントハンドラの登録</p> +<p>各アプリからHomeScreenアプリケーションのOnScreenに表示するイベントを発行する</p> +<h4>Parameters</h4> +<ul> +<li>et [in] : 対象のイベント</li> +<li>f [in] : イベントハンドラ</li> +</ul> +<h4>Return</h4> +<p>Nothing </p> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00305">305</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> {</div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  <span class="keywordflow">if</span> (et >= 1 && et <= 2) {</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="keywordflow">switch</span> (et) {</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  <span class="keywordflow">case</span> <a class="code" href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154a4b0a82d501e4db5fbfe25c254c92896f">Event_TapShortcut</a>:</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  this-><a class="code" href="../../de/dd0/class_lib_home_screen.html#aa4c189807b75d070f567967f0d690738">subscribe</a>(<a class="code" href="../../de/dd0/class_lib_home_screen.html#a6a6d8a4d33a006a08652e7377a4c29e9">LibHomeScreen::event_list</a>[0]);</div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  <span class="keywordflow">case</span> <a class="code" href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154aea56fa32a124a8ddcbea127755280a1d">Event_OnScreenMessage</a>:</div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  this-><a class="code" href="../../de/dd0/class_lib_home_screen.html#aa4c189807b75d070f567967f0d690738">subscribe</a>(<a class="code" href="../../de/dd0/class_lib_home_screen.html#a6a6d8a4d33a006a08652e7377a4c29e9">LibHomeScreen::event_list</a>[1]);</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  }</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> </div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  this->handlers[et] = std::move(f);</div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  }</div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> }</div><div class="ttc" id="class_lib_home_screen_html_a82616c91ac211d2ad08e709b524bf154aea56fa32a124a8ddcbea127755280a1d"><div class="ttname"><a href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154aea56fa32a124a8ddcbea127755280a1d">LibHomeScreen::Event_OnScreenMessage</a></div><div class="ttdef"><b>Definition:</b> <a href="../../df/d43/libhomescreen_8hpp_source.html#l00045">libhomescreen.hpp:45</a></div></div> +<div class="ttc" id="class_lib_home_screen_html_aa4c189807b75d070f567967f0d690738"><div class="ttname"><a href="../../de/dd0/class_lib_home_screen.html#aa4c189807b75d070f567967f0d690738">LibHomeScreen::subscribe</a></div><div class="ttdeci">int subscribe(const std::string &event_name)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00401">libhomescreen.cpp:401</a></div></div> +<div class="ttc" id="class_lib_home_screen_html_a6a6d8a4d33a006a08652e7377a4c29e9"><div class="ttname"><a href="../../de/dd0/class_lib_home_screen.html#a6a6d8a4d33a006a08652e7377a4c29e9">LibHomeScreen::event_list</a></div><div class="ttdeci">static const std::vector< std::string > event_list</div><div class="ttdef"><b>Definition:</b> <a href="../../df/d43/libhomescreen_8hpp_source.html#l00049">libhomescreen.hpp:49</a></div></div> +<div class="ttc" id="class_lib_home_screen_html_a82616c91ac211d2ad08e709b524bf154a4b0a82d501e4db5fbfe25c254c92896f"><div class="ttname"><a href="../../de/dd0/class_lib_home_screen.html#a82616c91ac211d2ad08e709b524bf154a4b0a82d501e4db5fbfe25c254c92896f">LibHomeScreen::Event_TapShortcut</a></div><div class="ttdef"><b>Definition:</b> <a href="../../df/d43/libhomescreen_8hpp_source.html#l00044">libhomescreen.hpp:44</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="aa4c189807b75d070f567967f0d690738"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa4c189807b75d070f567967f0d690738">◆ </a></span>subscribe()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int LibHomeScreen::subscribe </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>event_name</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Register callback function for each event</p> +<h4>Parameters</h4> +<ul> +<li>event_name [in] : This argument should be specified to the event name</li> +</ul> +<h4>Return</h4> +<ul> +<li>Returns 0 on success or -1 in case of error.</li> +</ul> +<h4>Note</h4> +<p>This function enables to get an event to your callback function. </p> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00401">401</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00402"></a><span class="lineno"> 402</span> {</div><div class="line"><a name="l00403"></a><span class="lineno"> 403</span>  <span class="keywordflow">if</span>(!sp_websock)</div><div class="line"><a name="l00404"></a><span class="lineno"> 404</span>  {</div><div class="line"><a name="l00405"></a><span class="lineno"> 405</span>  <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00406"></a><span class="lineno"> 406</span>  }</div><div class="line"><a name="l00407"></a><span class="lineno"> 407</span>  <span class="keyword">struct </span>json_object* j_obj = json_object_new_object();</div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span>  json_object_object_add(j_obj, <span class="stringliteral">"event"</span>, json_object_new_string(event_name.c_str()));</div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span> </div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span>  <span class="keywordtype">int</span> ret = afb_wsj1_call_j(sp_websock, <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a1e2d6e77dd8f0162f830058579eab42f">API</a>, <span class="stringliteral">"subscribe"</span>, j_obj, <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a7778933bffa862c63fa0a1b8219faa8b">_on_reply_static</a>, <span class="keyword">this</span>);</div><div class="line"><a name="l00411"></a><span class="lineno"> 411</span>  <span class="keywordflow">if</span> (ret < 0) {</div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span>  <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a>(<span class="stringliteral">"Failed to call verb:%s"</span>,__FUNCTION__);</div><div class="line"><a name="l00413"></a><span class="lineno"> 413</span>  }</div><div class="line"><a name="l00414"></a><span class="lineno"> 414</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00415"></a><span class="lineno"> 415</span> }</div><div class="ttc" id="libhomescreen_8cpp_html_a1e2d6e77dd8f0162f830058579eab42f"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a1e2d6e77dd8f0162f830058579eab42f">API</a></div><div class="ttdeci">static const char API[]</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00040">libhomescreen.cpp:40</a></div></div> +<div class="ttc" id="libhomescreen_8cpp_html_a797aa3053bd6a29819d44f8fad8a5eca"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a></div><div class="ttdeci">#define ELOG(args,...)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00032">libhomescreen.cpp:32</a></div></div> +<div class="ttc" id="libhomescreen_8cpp_html_a7778933bffa862c63fa0a1b8219faa8b"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a7778933bffa862c63fa0a1b8219faa8b">_on_reply_static</a></div><div class="ttdeci">static void _on_reply_static(void *closure, struct afb_wsj1_msg *msg)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00076">libhomescreen.cpp:76</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="afb571c9577087b47065eb23e7fdbc903"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afb571c9577087b47065eb23e7fdbc903">◆ </a></span>tapShortcut()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int LibHomeScreen::tapShortcut </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>application_name</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>ショートカットアイコンがタップされたイベントの発行</p> +<p>HomeScreenアプリケーションにて各アプリアイコンがタップされたときにイベントを発行する</p> +<h4>Parameters</h4> +<ul> +<li>application_name [in] : タップされたアプリケーションの名前(label)</li> +</ul> +<h4>Return</h4> +<ul> +<li>Returns 0 on success or -1 in case of error. </li> +</ul> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00256">256</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> {</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  <span class="keywordflow">if</span>(!sp_websock)</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  {</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  }</div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> </div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="keyword">struct </span>json_object* j_obj = json_object_new_object();</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="keyword">struct </span>json_object* val = json_object_new_string(application_name);</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  json_object_object_add(j_obj, <span class="stringliteral">"application_name"</span>, val);</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keywordflow">return</span> this-><a class="code" href="../../de/dd0/class_lib_home_screen.html#a527b49dcfe581be6275d0eb2236ba37f">call</a>(<span class="stringliteral">"tap_shortcut"</span>, j_obj);</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> }</div><div class="ttc" id="class_lib_home_screen_html_a527b49dcfe581be6275d0eb2236ba37f"><div class="ttname"><a href="../../de/dd0/class_lib_home_screen.html#a527b49dcfe581be6275d0eb2236ba37f">LibHomeScreen::call</a></div><div class="ttdeci">int call(const std::string &verb, struct json_object *arg)</div></div> +</div><!-- fragment --> +</div> +</div> +<a id="aac03a45cbd453ba69ddb00c1016930a6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aac03a45cbd453ba69ddb00c1016930a6">◆ </a></span>unsubscribe()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int LibHomeScreen::unsubscribe </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>event_name</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Unregister callback function for each event</p> +<h4>Parameters</h4> +<ul> +<li>event_name [in] : This argument should be specified to the event name</li> +</ul> +<h4>Return</h4> +<ul> +<li>Returns 0 on success or -1 in case of error.</li> +</ul> +<h4>Note</h4> +<p>This function disables to get an event to your callback function. </p> + +<p class="definition">Definition at line <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html#l00430">430</a> of file <a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00431"></a><span class="lineno"> 431</span> {</div><div class="line"><a name="l00432"></a><span class="lineno"> 432</span>  <span class="keywordflow">if</span>(!sp_websock)</div><div class="line"><a name="l00433"></a><span class="lineno"> 433</span>  {</div><div class="line"><a name="l00434"></a><span class="lineno"> 434</span>  <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00435"></a><span class="lineno"> 435</span>  }</div><div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  <span class="keyword">struct </span>json_object* j_obj = json_object_new_object();</div><div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  json_object_object_add(j_obj, <span class="stringliteral">"event"</span>, json_object_new_string(event_name.c_str()));</div><div class="line"><a name="l00438"></a><span class="lineno"> 438</span> </div><div class="line"><a name="l00439"></a><span class="lineno"> 439</span>  <span class="keywordtype">int</span> ret = afb_wsj1_call_j(sp_websock, <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a1e2d6e77dd8f0162f830058579eab42f">API</a>, <span class="stringliteral">"unsubscribe"</span>, j_obj, <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a7778933bffa862c63fa0a1b8219faa8b">_on_reply_static</a>, <span class="keyword">this</span>);</div><div class="line"><a name="l00440"></a><span class="lineno"> 440</span>  <span class="keywordflow">if</span> (ret < 0) {</div><div class="line"><a name="l00441"></a><span class="lineno"> 441</span>  <a class="code" href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a>(<span class="stringliteral">"Failed to call verb:%s"</span>,__FUNCTION__);</div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  }</div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00444"></a><span class="lineno"> 444</span> }</div><div class="ttc" id="libhomescreen_8cpp_html_a1e2d6e77dd8f0162f830058579eab42f"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a1e2d6e77dd8f0162f830058579eab42f">API</a></div><div class="ttdeci">static const char API[]</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00040">libhomescreen.cpp:40</a></div></div> +<div class="ttc" id="libhomescreen_8cpp_html_a797aa3053bd6a29819d44f8fad8a5eca"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a797aa3053bd6a29819d44f8fad8a5eca">ELOG</a></div><div class="ttdeci">#define ELOG(args,...)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00032">libhomescreen.cpp:32</a></div></div> +<div class="ttc" id="libhomescreen_8cpp_html_a7778933bffa862c63fa0a1b8219faa8b"><div class="ttname"><a href="../../d0/d8a/libhomescreen_8cpp.html#a7778933bffa862c63fa0a1b8219faa8b">_on_reply_static</a></div><div class="ttdeci">static void _on_reply_static(void *closure, struct afb_wsj1_msg *msg)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d8a/libhomescreen_8cpp_source.html#l00076">libhomescreen.cpp:76</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a5593ff5ac78f6495ccb649904cf0ab08"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5593ff5ac78f6495ccb649904cf0ab08">◆ </a></span>api_list</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const std::vector< std::string > LibHomeScreen::api_list</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<b>Initial value:</b><div class="fragment"><div class="line">{</div><div class="line"> std::string(<span class="stringliteral">"ping"</span>), </div><div class="line"> std::string(<span class="stringliteral">"tap_shortcut"</span>), </div><div class="line"> std::string(<span class="stringliteral">"on_screen_message"</span>),</div><div class="line"> std::string(<span class="stringliteral">"subscribe"</span>),</div><div class="line"> std::string(<span class="stringliteral">"unsubscribe"</span>)</div><div class="line">}</div></div><!-- fragment --> +<p class="definition">Definition at line <a class="el" href="../../df/d43/libhomescreen_8hpp_source.html#l00048">48</a> of file <a class="el" href="../../df/d43/libhomescreen_8hpp_source.html">libhomescreen.hpp</a>.</p> + +</div> +</div> +<a id="a6a6d8a4d33a006a08652e7377a4c29e9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6a6d8a4d33a006a08652e7377a4c29e9">◆ </a></span>event_list</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const std::vector< std::string > LibHomeScreen::event_list</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<b>Initial value:</b><div class="fragment"><div class="line">{</div><div class="line"> std::string(<span class="stringliteral">"tap_shortcut"</span>),</div><div class="line"> std::string(<span class="stringliteral">"on_screen_message"</span>),</div><div class="line"> std::string(<span class="stringliteral">"none"</span>)</div><div class="line">}</div></div><!-- fragment --> +<p class="definition">Definition at line <a class="el" href="../../df/d43/libhomescreen_8hpp_source.html#l00049">49</a> of file <a class="el" href="../../df/d43/libhomescreen_8hpp_source.html">libhomescreen.hpp</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>include/libhomescreen/<a class="el" href="../../df/d43/libhomescreen_8hpp_source.html">libhomescreen.hpp</a></li> +<li>libhomescreen/<a class="el" href="../../d0/d8a/libhomescreen_8cpp_source.html">libhomescreen.cpp</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="../../doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> |