diagnostics__relay_8h.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.8"/>
  7. <title>libimobiledevice: libimobiledevice/diagnostics_relay.h File Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">libimobiledevice
  21. &#160;<span id="projectnumber">1.2.0</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.8 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  34. <li class="current"><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. <div id="navrow2" class="tabs2">
  38. <ul class="tablist">
  39. <li><a href="files.html"><span>File&#160;List</span></a></li>
  40. <li><a href="globals.html"><span>Globals</span></a></li>
  41. </ul>
  42. </div>
  43. <div id="nav-path" class="navpath">
  44. <ul>
  45. <li class="navelem"><a class="el" href="dir_6f94c0669708509ba6e66291c679659c.html">libimobiledevice</a></li> </ul>
  46. </div>
  47. </div><!-- top -->
  48. <div class="header">
  49. <div class="summary">
  50. <a href="#define-members">Macros</a> &#124;
  51. <a href="#typedef-members">Typedefs</a> &#124;
  52. <a href="#enum-members">Enumerations</a> &#124;
  53. <a href="#func-members">Functions</a> </div>
  54. <div class="headertitle">
  55. <div class="title">diagnostics_relay.h File Reference</div> </div>
  56. </div><!--header-->
  57. <div class="contents">
  58. <p>Request iOS diagnostic information from device.
  59. <a href="#details">More...</a></p>
  60. <table class="memberdecls">
  61. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  62. Macros</h2></td></tr>
  63. <tr class="memitem:aaa163d43bad93408ea10e9958dee0015"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa163d43bad93408ea10e9958dee0015"></a>
  64. #define&#160;</td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_SERVICE_NAME</b>&#160;&#160;&#160;&quot;com.apple.mobile.diagnostics_relay&quot;</td></tr>
  65. <tr class="separator:aaa163d43bad93408ea10e9958dee0015"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a913043c9b578cfab6f39ede0f3103bfe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a913043c9b578cfab6f39ede0f3103bfe"></a>
  67. #define&#160;</td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_ACTION_FLAG_WAIT_FOR_DISCONNECT</b>&#160;&#160;&#160;(1 &lt;&lt; 1)</td></tr>
  68. <tr class="separator:a913043c9b578cfab6f39ede0f3103bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a5d345bfac4245d7c5b34f54e27688db6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d345bfac4245d7c5b34f54e27688db6"></a>
  70. #define&#160;</td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_PASS</b>&#160;&#160;&#160;(1 &lt;&lt; 2)</td></tr>
  71. <tr class="separator:a5d345bfac4245d7c5b34f54e27688db6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a9e7d8459ffe14f08d906962ae8d6f488"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e7d8459ffe14f08d906962ae8d6f488"></a>
  73. #define&#160;</td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_FAIL</b>&#160;&#160;&#160;(1 &lt;&lt; 3)</td></tr>
  74. <tr class="separator:a9e7d8459ffe14f08d906962ae8d6f488"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a0dcb42d6ec4f13360ced86eca475ebaa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0dcb42d6ec4f13360ced86eca475ebaa"></a>
  76. #define&#160;</td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_REQUEST_TYPE_ALL</b>&#160;&#160;&#160;&quot;All&quot;</td></tr>
  77. <tr class="separator:a0dcb42d6ec4f13360ced86eca475ebaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a3c62491868899198a0e7aa74655b063a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c62491868899198a0e7aa74655b063a"></a>
  79. #define&#160;</td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_REQUEST_TYPE_WIFI</b>&#160;&#160;&#160;&quot;WiFi&quot;</td></tr>
  80. <tr class="separator:a3c62491868899198a0e7aa74655b063a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a316b962da7a70ac8f1d704b308de3fe5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a316b962da7a70ac8f1d704b308de3fe5"></a>
  82. #define&#160;</td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_REQUEST_TYPE_GAS_GAUGE</b>&#160;&#160;&#160;&quot;GasGauge&quot;</td></tr>
  83. <tr class="separator:a316b962da7a70ac8f1d704b308de3fe5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a08c5682fb9af6b502e944ee86856577d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08c5682fb9af6b502e944ee86856577d"></a>
  85. #define&#160;</td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_REQUEST_TYPE_NAND</b>&#160;&#160;&#160;&quot;NAND&quot;</td></tr>
  86. <tr class="separator:a08c5682fb9af6b502e944ee86856577d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table><table class="memberdecls">
  88. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  89. Typedefs</h2></td></tr>
  90. <tr class="memitem:a2ba0bbe8232e06365376223ca85c336f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ba0bbe8232e06365376223ca85c336f"></a>
  91. typedef struct <br class="typebreak" />
  92. diagnostics_relay_client_private&#160;</td><td class="memItemRight" valign="bottom"><b>diagnostics_relay_client_private</b></td></tr>
  93. <tr class="separator:a2ba0bbe8232e06365376223ca85c336f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a7a0213ab3558d483f2ca0a59ddf81311"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
  95. diagnostics_relay_client_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a></td></tr>
  96. <tr class="memdesc:a7a0213ab3558d483f2ca0a59ddf81311"><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle. <a href="#a7a0213ab3558d483f2ca0a59ddf81311">More...</a><br /></td></tr>
  97. <tr class="separator:a7a0213ab3558d483f2ca0a59ddf81311"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. </table><table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  100. Enumerations</h2></td></tr>
  101. <tr class="memitem:a7f980002ddc6e5396fb9fef14be9893e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f980002ddc6e5396fb9fef14be9893e"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> { <br />
  102. &#160;&#160;<b>DIAGNOSTICS_RELAY_E_SUCCESS</b> = 0,
  103. <br />
  104. &#160;&#160;<b>DIAGNOSTICS_RELAY_E_INVALID_ARG</b> = -1,
  105. <br />
  106. &#160;&#160;<b>DIAGNOSTICS_RELAY_E_PLIST_ERROR</b> = -2,
  107. <br />
  108. &#160;&#160;<b>DIAGNOSTICS_RELAY_E_MUX_ERROR</b> = -3,
  109. <br />
  110. &#160;&#160;<b>DIAGNOSTICS_RELAY_E_UNKNOWN_REQUEST</b> = -4,
  111. <br />
  112. &#160;&#160;<b>DIAGNOSTICS_RELAY_E_UNKNOWN_ERROR</b> = -256
  113. <br />
  114. }</td></tr>
  115. <tr class="memdesc:a7f980002ddc6e5396fb9fef14be9893e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error Codes. <br /></td></tr>
  116. <tr class="separator:a7f980002ddc6e5396fb9fef14be9893e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. </table><table class="memberdecls">
  118. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  119. Functions</h2></td></tr>
  120. <tr class="memitem:adcd42619260173a07c120a2e889318a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="diagnostics__relay_8h.html#adcd42619260173a07c120a2e889318a0">diagnostics_relay_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> *client)</td></tr>
  121. <tr class="memdesc:adcd42619260173a07c120a2e889318a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the diagnostics_relay service on the specified device. <a href="#adcd42619260173a07c120a2e889318a0">More...</a><br /></td></tr>
  122. <tr class="separator:adcd42619260173a07c120a2e889318a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a4b732019d5170aeec2a51d1310b745e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="diagnostics__relay_8h.html#a4b732019d5170aeec2a51d1310b745e4">diagnostics_relay_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> *client, const char *label)</td></tr>
  124. <tr class="memdesc:a4b732019d5170aeec2a51d1310b745e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a new diagnostics_relay service on the specified device and connects to it. <a href="#a4b732019d5170aeec2a51d1310b745e4">More...</a><br /></td></tr>
  125. <tr class="separator:a4b732019d5170aeec2a51d1310b745e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a000be08611a71876c897d2ac050c9161"><td class="memItemLeft" align="right" valign="top"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="diagnostics__relay_8h.html#a000be08611a71876c897d2ac050c9161">diagnostics_relay_client_free</a> (<a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> client)</td></tr>
  127. <tr class="memdesc:a000be08611a71876c897d2ac050c9161"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a diagnostics_relay client from the device and frees up the diagnostics_relay client data. <a href="#a000be08611a71876c897d2ac050c9161">More...</a><br /></td></tr>
  128. <tr class="separator:a000be08611a71876c897d2ac050c9161"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ace004b6c06cf057ce6e2a52c5ef20f3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="diagnostics__relay_8h.html#ace004b6c06cf057ce6e2a52c5ef20f3e">diagnostics_relay_goodbye</a> (<a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> client)</td></tr>
  130. <tr class="memdesc:ace004b6c06cf057ce6e2a52c5ef20f3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends the Goodbye request signaling the end of communication. <a href="#ace004b6c06cf057ce6e2a52c5ef20f3e">More...</a><br /></td></tr>
  131. <tr class="separator:ace004b6c06cf057ce6e2a52c5ef20f3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a53dde7b6bc19417df267198f5356ae83"><td class="memItemLeft" align="right" valign="top"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="diagnostics__relay_8h.html#a53dde7b6bc19417df267198f5356ae83">diagnostics_relay_sleep</a> (<a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> client)</td></tr>
  133. <tr class="memdesc:a53dde7b6bc19417df267198f5356ae83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Puts the device into deep sleep mode and disconnects from host. <a href="#a53dde7b6bc19417df267198f5356ae83">More...</a><br /></td></tr>
  134. <tr class="separator:a53dde7b6bc19417df267198f5356ae83"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ae2718e638b4d66c6da7271eda81181ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="diagnostics__relay_8h.html#ae2718e638b4d66c6da7271eda81181ea">diagnostics_relay_restart</a> (<a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> client, int flags)</td></tr>
  136. <tr class="memdesc:ae2718e638b4d66c6da7271eda81181ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restart the device and optionally show a user notification. <a href="#ae2718e638b4d66c6da7271eda81181ea">More...</a><br /></td></tr>
  137. <tr class="separator:ae2718e638b4d66c6da7271eda81181ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:ab056df27d421ca56559b99528acd51ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="diagnostics__relay_8h.html#ab056df27d421ca56559b99528acd51ff">diagnostics_relay_shutdown</a> (<a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> client, int flags)</td></tr>
  139. <tr class="memdesc:ab056df27d421ca56559b99528acd51ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shutdown of the device and optionally show a user notification. <a href="#ab056df27d421ca56559b99528acd51ff">More...</a><br /></td></tr>
  140. <tr class="separator:ab056df27d421ca56559b99528acd51ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:aa940b00a740099fbef62169551c9cc9c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="diagnostics__relay_8h.html#aa940b00a740099fbef62169551c9cc9c">diagnostics_relay_request_diagnostics</a> (<a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> client, const char *type, plist_t *diagnostics)</td></tr>
  142. <tr class="memdesc:aa940b00a740099fbef62169551c9cc9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shutdown of the device and optionally show a user notification. <a href="#aa940b00a740099fbef62169551c9cc9c">More...</a><br /></td></tr>
  143. <tr class="separator:aa940b00a740099fbef62169551c9cc9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a50676920f6cd761b4e9dab9240f819df"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50676920f6cd761b4e9dab9240f819df"></a>
  145. <a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>diagnostics_relay_query_mobilegestalt</b> (<a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> client, plist_t keys, plist_t *result)</td></tr>
  146. <tr class="separator:a50676920f6cd761b4e9dab9240f819df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a67809ea74607bc005b0e1825ca1d1f0d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67809ea74607bc005b0e1825ca1d1f0d"></a>
  148. <a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>diagnostics_relay_query_ioregistry_entry</b> (<a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> client, const char *name, const char *class, plist_t *result)</td></tr>
  149. <tr class="separator:a67809ea74607bc005b0e1825ca1d1f0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a611082acad1de105d8e4660422407546"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a611082acad1de105d8e4660422407546"></a>
  151. <a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>diagnostics_relay_query_ioregistry_plane</b> (<a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> client, const char *plane, plist_t *result)</td></tr>
  152. <tr class="separator:a611082acad1de105d8e4660422407546"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. </table>
  154. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  155. <div class="textblock"><p>Request iOS diagnostic information from device. </p>
  156. </div><h2 class="groupheader">Typedef Documentation</h2>
  157. <a class="anchor" id="a7a0213ab3558d483f2ca0a59ddf81311"></a>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">typedef diagnostics_relay_client_private* <a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a></td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>The client handle. </p>
  167. </div>
  168. </div>
  169. <h2 class="groupheader">Function Documentation</h2>
  170. <a class="anchor" id="a000be08611a71876c897d2ac050c9161"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_client_free </td>
  176. <td>(</td>
  177. <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a>&#160;</td>
  178. <td class="paramname"><em>client</em></td><td>)</td>
  179. <td></td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. <p>Disconnects a diagnostics_relay client from the device and frees up the diagnostics_relay client data. </p>
  184. <dl class="params"><dt>Parameters</dt><dd>
  185. <table class="params">
  186. <tr><td class="paramname">client</td><td>The diagnostics_relay client to disconnect and free.</td></tr>
  187. </table>
  188. </dd>
  189. </dl>
  190. <dl class="section return"><dt>Returns</dt><dd>DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when one of client or client-&gt;parent is invalid, or DIAGNOSTICS_RELAY_E_UNKNOWN_ERROR when the was an error freeing the parent property_list_service client. </dd></dl>
  191. </div>
  192. </div>
  193. <a class="anchor" id="adcd42619260173a07c120a2e889318a0"></a>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_client_new </td>
  199. <td>(</td>
  200. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  201. <td class="paramname"><em>device</em>, </td>
  202. </tr>
  203. <tr>
  204. <td class="paramkey"></td>
  205. <td></td>
  206. <td class="paramtype">lockdownd_service_descriptor_t&#160;</td>
  207. <td class="paramname"><em>service</em>, </td>
  208. </tr>
  209. <tr>
  210. <td class="paramkey"></td>
  211. <td></td>
  212. <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> *&#160;</td>
  213. <td class="paramname"><em>client</em>&#160;</td>
  214. </tr>
  215. <tr>
  216. <td></td>
  217. <td>)</td>
  218. <td></td><td></td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Connects to the diagnostics_relay service on the specified device. </p>
  223. <dl class="params"><dt>Parameters</dt><dd>
  224. <table class="params">
  225. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  226. <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
  227. <tr><td class="paramname">client</td><td>Reference that will point to a newly allocated diagnostics_relay_client_t upon successful return.</td></tr>
  228. </table>
  229. </dd>
  230. </dl>
  231. <dl class="section return"><dt>Returns</dt><dd>DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when one of the parameters is invalid, or DIAGNOSTICS_RELAY_E_MUX_ERROR when the connection failed. </dd></dl>
  232. </div>
  233. </div>
  234. <a class="anchor" id="a4b732019d5170aeec2a51d1310b745e4"></a>
  235. <div class="memitem">
  236. <div class="memproto">
  237. <table class="memname">
  238. <tr>
  239. <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_client_start_service </td>
  240. <td>(</td>
  241. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  242. <td class="paramname"><em>device</em>, </td>
  243. </tr>
  244. <tr>
  245. <td class="paramkey"></td>
  246. <td></td>
  247. <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> *&#160;</td>
  248. <td class="paramname"><em>client</em>, </td>
  249. </tr>
  250. <tr>
  251. <td class="paramkey"></td>
  252. <td></td>
  253. <td class="paramtype">const char *&#160;</td>
  254. <td class="paramname"><em>label</em>&#160;</td>
  255. </tr>
  256. <tr>
  257. <td></td>
  258. <td>)</td>
  259. <td></td><td></td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. <p>Starts a new diagnostics_relay service on the specified device and connects to it. </p>
  264. <dl class="params"><dt>Parameters</dt><dd>
  265. <table class="params">
  266. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  267. <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated diagnostics_relay_client_t upon successful return. Must be freed using <a class="el" href="diagnostics__relay_8h.html#a000be08611a71876c897d2ac050c9161" title="Disconnects a diagnostics_relay client from the device and frees up the diagnostics_relay client data...">diagnostics_relay_client_free()</a> after use. </td></tr>
  268. <tr><td class="paramname">label</td><td>The label to use for communication. Usually the program name. Pass NULL to disable sending the label in requests to lockdownd.</td></tr>
  269. </table>
  270. </dd>
  271. </dl>
  272. <dl class="section return"><dt>Returns</dt><dd>DIAGNOSTICS_RELAY_E_SUCCESS on success, or an DIAGNOSTICS_RELAY_E_* error code otherwise. </dd></dl>
  273. </div>
  274. </div>
  275. <a class="anchor" id="ace004b6c06cf057ce6e2a52c5ef20f3e"></a>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_goodbye </td>
  281. <td>(</td>
  282. <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a>&#160;</td>
  283. <td class="paramname"><em>client</em></td><td>)</td>
  284. <td></td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. <p>Sends the Goodbye request signaling the end of communication. </p>
  289. <dl class="params"><dt>Parameters</dt><dd>
  290. <table class="params">
  291. <tr><td class="paramname">client</td><td>The diagnostics_relay client</td></tr>
  292. </table>
  293. </dd>
  294. </dl>
  295. <dl class="section return"><dt>Returns</dt><dd>DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client is NULL, DIAGNOSTICS_RELAY_E_PLIST_ERROR if the device did not acknowledge the request </dd></dl>
  296. </div>
  297. </div>
  298. <a class="anchor" id="aa940b00a740099fbef62169551c9cc9c"></a>
  299. <div class="memitem">
  300. <div class="memproto">
  301. <table class="memname">
  302. <tr>
  303. <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_request_diagnostics </td>
  304. <td>(</td>
  305. <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a>&#160;</td>
  306. <td class="paramname"><em>client</em>, </td>
  307. </tr>
  308. <tr>
  309. <td class="paramkey"></td>
  310. <td></td>
  311. <td class="paramtype">const char *&#160;</td>
  312. <td class="paramname"><em>type</em>, </td>
  313. </tr>
  314. <tr>
  315. <td class="paramkey"></td>
  316. <td></td>
  317. <td class="paramtype">plist_t *&#160;</td>
  318. <td class="paramname"><em>diagnostics</em>&#160;</td>
  319. </tr>
  320. <tr>
  321. <td></td>
  322. <td>)</td>
  323. <td></td><td></td>
  324. </tr>
  325. </table>
  326. </div><div class="memdoc">
  327. <p>Shutdown of the device and optionally show a user notification. </p>
  328. <dl class="params"><dt>Parameters</dt><dd>
  329. <table class="params">
  330. <tr><td class="paramname">client</td><td>The diagnostics_relay client </td></tr>
  331. <tr><td class="paramname">flags</td><td>A binary flag combination of DIAGNOSTICS_RELAY_ACTION_FLAG_WAIT_FOR_DISCONNECT to wait until <a class="el" href="diagnostics__relay_8h.html#a000be08611a71876c897d2ac050c9161" title="Disconnects a diagnostics_relay client from the device and frees up the diagnostics_relay client data...">diagnostics_relay_client_free()</a> disconnects before execution and DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_FAIL to show a "FAIL" dialog or DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_PASS to show an "OK" dialog</td></tr>
  332. </table>
  333. </dd>
  334. </dl>
  335. <dl class="section return"><dt>Returns</dt><dd>DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client is NULL, DIAGNOSTICS_RELAY_E_PLIST_ERROR if the device did not acknowledge the request </dd></dl>
  336. </div>
  337. </div>
  338. <a class="anchor" id="ae2718e638b4d66c6da7271eda81181ea"></a>
  339. <div class="memitem">
  340. <div class="memproto">
  341. <table class="memname">
  342. <tr>
  343. <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_restart </td>
  344. <td>(</td>
  345. <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a>&#160;</td>
  346. <td class="paramname"><em>client</em>, </td>
  347. </tr>
  348. <tr>
  349. <td class="paramkey"></td>
  350. <td></td>
  351. <td class="paramtype">int&#160;</td>
  352. <td class="paramname"><em>flags</em>&#160;</td>
  353. </tr>
  354. <tr>
  355. <td></td>
  356. <td>)</td>
  357. <td></td><td></td>
  358. </tr>
  359. </table>
  360. </div><div class="memdoc">
  361. <p>Restart the device and optionally show a user notification. </p>
  362. <dl class="params"><dt>Parameters</dt><dd>
  363. <table class="params">
  364. <tr><td class="paramname">client</td><td>The diagnostics_relay client </td></tr>
  365. <tr><td class="paramname">flags</td><td>A binary flag combination of DIAGNOSTICS_RELAY_ACTION_FLAG_WAIT_FOR_DISCONNECT to wait until <a class="el" href="diagnostics__relay_8h.html#a000be08611a71876c897d2ac050c9161" title="Disconnects a diagnostics_relay client from the device and frees up the diagnostics_relay client data...">diagnostics_relay_client_free()</a> disconnects before execution and DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_FAIL to show a "FAIL" dialog or DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_PASS to show an "OK" dialog</td></tr>
  366. </table>
  367. </dd>
  368. </dl>
  369. <dl class="section return"><dt>Returns</dt><dd>DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client is NULL, DIAGNOSTICS_RELAY_E_PLIST_ERROR if the device did not acknowledge the request </dd></dl>
  370. </div>
  371. </div>
  372. <a class="anchor" id="ab056df27d421ca56559b99528acd51ff"></a>
  373. <div class="memitem">
  374. <div class="memproto">
  375. <table class="memname">
  376. <tr>
  377. <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_shutdown </td>
  378. <td>(</td>
  379. <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a>&#160;</td>
  380. <td class="paramname"><em>client</em>, </td>
  381. </tr>
  382. <tr>
  383. <td class="paramkey"></td>
  384. <td></td>
  385. <td class="paramtype">int&#160;</td>
  386. <td class="paramname"><em>flags</em>&#160;</td>
  387. </tr>
  388. <tr>
  389. <td></td>
  390. <td>)</td>
  391. <td></td><td></td>
  392. </tr>
  393. </table>
  394. </div><div class="memdoc">
  395. <p>Shutdown of the device and optionally show a user notification. </p>
  396. <dl class="params"><dt>Parameters</dt><dd>
  397. <table class="params">
  398. <tr><td class="paramname">client</td><td>The diagnostics_relay client </td></tr>
  399. <tr><td class="paramname">flags</td><td>A binary flag combination of DIAGNOSTICS_RELAY_ACTION_FLAG_WAIT_FOR_DISCONNECT to wait until <a class="el" href="diagnostics__relay_8h.html#a000be08611a71876c897d2ac050c9161" title="Disconnects a diagnostics_relay client from the device and frees up the diagnostics_relay client data...">diagnostics_relay_client_free()</a> disconnects before execution and DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_FAIL to show a "FAIL" dialog or DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_PASS to show an "OK" dialog</td></tr>
  400. </table>
  401. </dd>
  402. </dl>
  403. <dl class="section return"><dt>Returns</dt><dd>DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client is NULL, DIAGNOSTICS_RELAY_E_PLIST_ERROR if the device did not acknowledge the request </dd></dl>
  404. </div>
  405. </div>
  406. <a class="anchor" id="a53dde7b6bc19417df267198f5356ae83"></a>
  407. <div class="memitem">
  408. <div class="memproto">
  409. <table class="memname">
  410. <tr>
  411. <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_sleep </td>
  412. <td>(</td>
  413. <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a>&#160;</td>
  414. <td class="paramname"><em>client</em></td><td>)</td>
  415. <td></td>
  416. </tr>
  417. </table>
  418. </div><div class="memdoc">
  419. <p>Puts the device into deep sleep mode and disconnects from host. </p>
  420. <dl class="params"><dt>Parameters</dt><dd>
  421. <table class="params">
  422. <tr><td class="paramname">client</td><td>The diagnostics_relay client</td></tr>
  423. </table>
  424. </dd>
  425. </dl>
  426. <dl class="section return"><dt>Returns</dt><dd>DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client is NULL, DIAGNOSTICS_RELAY_E_PLIST_ERROR if the device did not acknowledge the request </dd></dl>
  427. </div>
  428. </div>
  429. </div><!-- contents -->
  430. <!-- start footer part -->
  431. <hr class="footer"/><address class="footer"><small>
  432. Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by &#160;<a href="http://www.doxygen.org/index.html">
  433. <img class="footer" src="doxygen.png" alt="doxygen"/>
  434. </a> 1.8.8
  435. </small></address>
  436. </body>
  437. </html>