| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456 |
- <!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.8"/>
- <title>libimobiledevice: libimobiledevice/diagnostics_relay.h File 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="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 style="padding-left: 0.5em;">
- <div id="projectname">libimobiledevice
-  <span id="projectnumber">1.2.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.8 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
- <li class="current"><a href="files.html"><span>Files</span></a></li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="files.html"><span>File List</span></a></li>
- <li><a href="globals.html"><span>Globals</span></a></li>
- </ul>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="dir_6f94c0669708509ba6e66291c679659c.html">libimobiledevice</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#define-members">Macros</a> |
- <a href="#typedef-members">Typedefs</a> |
- <a href="#enum-members">Enumerations</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">diagnostics_relay.h File Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Request iOS diagnostic information from device.
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
- Macros</h2></td></tr>
- <tr class="memitem:aaa163d43bad93408ea10e9958dee0015"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa163d43bad93408ea10e9958dee0015"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_SERVICE_NAME</b>   "com.apple.mobile.diagnostics_relay"</td></tr>
- <tr class="separator:aaa163d43bad93408ea10e9958dee0015"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a913043c9b578cfab6f39ede0f3103bfe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a913043c9b578cfab6f39ede0f3103bfe"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_ACTION_FLAG_WAIT_FOR_DISCONNECT</b>   (1 << 1)</td></tr>
- <tr class="separator:a913043c9b578cfab6f39ede0f3103bfe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5d345bfac4245d7c5b34f54e27688db6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d345bfac4245d7c5b34f54e27688db6"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_PASS</b>   (1 << 2)</td></tr>
- <tr class="separator:a5d345bfac4245d7c5b34f54e27688db6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9e7d8459ffe14f08d906962ae8d6f488"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e7d8459ffe14f08d906962ae8d6f488"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_FAIL</b>   (1 << 3)</td></tr>
- <tr class="separator:a9e7d8459ffe14f08d906962ae8d6f488"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0dcb42d6ec4f13360ced86eca475ebaa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0dcb42d6ec4f13360ced86eca475ebaa"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_REQUEST_TYPE_ALL</b>   "All"</td></tr>
- <tr class="separator:a0dcb42d6ec4f13360ced86eca475ebaa"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3c62491868899198a0e7aa74655b063a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c62491868899198a0e7aa74655b063a"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_REQUEST_TYPE_WIFI</b>   "WiFi"</td></tr>
- <tr class="separator:a3c62491868899198a0e7aa74655b063a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a316b962da7a70ac8f1d704b308de3fe5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a316b962da7a70ac8f1d704b308de3fe5"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_REQUEST_TYPE_GAS_GAUGE</b>   "GasGauge"</td></tr>
- <tr class="separator:a316b962da7a70ac8f1d704b308de3fe5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a08c5682fb9af6b502e944ee86856577d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08c5682fb9af6b502e944ee86856577d"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>DIAGNOSTICS_RELAY_REQUEST_TYPE_NAND</b>   "NAND"</td></tr>
- <tr class="separator:a08c5682fb9af6b502e944ee86856577d"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
- Typedefs</h2></td></tr>
- <tr class="memitem:a2ba0bbe8232e06365376223ca85c336f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ba0bbe8232e06365376223ca85c336f"></a>
- typedef struct <br class="typebreak" />
- diagnostics_relay_client_private </td><td class="memItemRight" valign="bottom"><b>diagnostics_relay_client_private</b></td></tr>
- <tr class="separator:a2ba0bbe8232e06365376223ca85c336f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7a0213ab3558d483f2ca0a59ddf81311"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
- diagnostics_relay_client_private * </td><td class="memItemRight" valign="bottom"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a></td></tr>
- <tr class="memdesc:a7a0213ab3558d483f2ca0a59ddf81311"><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#a7a0213ab3558d483f2ca0a59ddf81311">More...</a><br /></td></tr>
- <tr class="separator:a7a0213ab3558d483f2ca0a59ddf81311"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
- Enumerations</h2></td></tr>
- <tr class="memitem:a7f980002ddc6e5396fb9fef14be9893e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f980002ddc6e5396fb9fef14be9893e"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> { <br />
-   <b>DIAGNOSTICS_RELAY_E_SUCCESS</b> = 0,
- <br />
-   <b>DIAGNOSTICS_RELAY_E_INVALID_ARG</b> = -1,
- <br />
-   <b>DIAGNOSTICS_RELAY_E_PLIST_ERROR</b> = -2,
- <br />
-   <b>DIAGNOSTICS_RELAY_E_MUX_ERROR</b> = -3,
- <br />
-   <b>DIAGNOSTICS_RELAY_E_UNKNOWN_REQUEST</b> = -4,
- <br />
-   <b>DIAGNOSTICS_RELAY_E_UNKNOWN_ERROR</b> = -256
- <br />
- }</td></tr>
- <tr class="memdesc:a7f980002ddc6e5396fb9fef14be9893e"><td class="mdescLeft"> </td><td class="mdescRight">Error Codes. <br /></td></tr>
- <tr class="separator:a7f980002ddc6e5396fb9fef14be9893e"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <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> </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>
- <tr class="memdesc:adcd42619260173a07c120a2e889318a0"><td class="mdescLeft"> </td><td class="mdescRight">Connects to the diagnostics_relay service on the specified device. <a href="#adcd42619260173a07c120a2e889318a0">More...</a><br /></td></tr>
- <tr class="separator:adcd42619260173a07c120a2e889318a0"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:a4b732019d5170aeec2a51d1310b745e4"><td class="mdescLeft"> </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>
- <tr class="separator:a4b732019d5170aeec2a51d1310b745e4"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:a000be08611a71876c897d2ac050c9161"><td class="mdescLeft"> </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>
- <tr class="separator:a000be08611a71876c897d2ac050c9161"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:ace004b6c06cf057ce6e2a52c5ef20f3e"><td class="mdescLeft"> </td><td class="mdescRight">Sends the Goodbye request signaling the end of communication. <a href="#ace004b6c06cf057ce6e2a52c5ef20f3e">More...</a><br /></td></tr>
- <tr class="separator:ace004b6c06cf057ce6e2a52c5ef20f3e"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:a53dde7b6bc19417df267198f5356ae83"><td class="mdescLeft"> </td><td class="mdescRight">Puts the device into deep sleep mode and disconnects from host. <a href="#a53dde7b6bc19417df267198f5356ae83">More...</a><br /></td></tr>
- <tr class="separator:a53dde7b6bc19417df267198f5356ae83"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:ae2718e638b4d66c6da7271eda81181ea"><td class="mdescLeft"> </td><td class="mdescRight">Restart the device and optionally show a user notification. <a href="#ae2718e638b4d66c6da7271eda81181ea">More...</a><br /></td></tr>
- <tr class="separator:ae2718e638b4d66c6da7271eda81181ea"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:ab056df27d421ca56559b99528acd51ff"><td class="mdescLeft"> </td><td class="mdescRight">Shutdown of the device and optionally show a user notification. <a href="#ab056df27d421ca56559b99528acd51ff">More...</a><br /></td></tr>
- <tr class="separator:ab056df27d421ca56559b99528acd51ff"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:aa940b00a740099fbef62169551c9cc9c"><td class="mdescLeft"> </td><td class="mdescRight">Shutdown of the device and optionally show a user notification. <a href="#aa940b00a740099fbef62169551c9cc9c">More...</a><br /></td></tr>
- <tr class="separator:aa940b00a740099fbef62169551c9cc9c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a50676920f6cd761b4e9dab9240f819df"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50676920f6cd761b4e9dab9240f819df"></a>
- <a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> </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>
- <tr class="separator:a50676920f6cd761b4e9dab9240f819df"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a67809ea74607bc005b0e1825ca1d1f0d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67809ea74607bc005b0e1825ca1d1f0d"></a>
- <a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> </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>
- <tr class="separator:a67809ea74607bc005b0e1825ca1d1f0d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a611082acad1de105d8e4660422407546"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a611082acad1de105d8e4660422407546"></a>
- <a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> </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>
- <tr class="separator:a611082acad1de105d8e4660422407546"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Request iOS diagnostic information from device. </p>
- </div><h2 class="groupheader">Typedef Documentation</h2>
- <a class="anchor" id="a7a0213ab3558d483f2ca0a59ddf81311"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef diagnostics_relay_client_private* <a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The client handle. </p>
- </div>
- </div>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="a000be08611a71876c897d2ac050c9161"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_client_free </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Disconnects a diagnostics_relay client from the device and frees up the diagnostics_relay client data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The diagnostics_relay client to disconnect and free.</td></tr>
- </table>
- </dd>
- </dl>
- <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->parent is invalid, or DIAGNOSTICS_RELAY_E_UNKNOWN_ERROR when the was an error freeing the parent property_list_service client. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="adcd42619260173a07c120a2e889318a0"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_client_new </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> </td>
- <td class="paramname"><em>device</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">lockdownd_service_descriptor_t </td>
- <td class="paramname"><em>service</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> * </td>
- <td class="paramname"><em>client</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Connects to the diagnostics_relay service on the specified device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
- <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
- <tr><td class="paramname">client</td><td>Reference that will point to a newly allocated diagnostics_relay_client_t upon successful return.</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a4b732019d5170aeec2a51d1310b745e4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_client_start_service </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> </td>
- <td class="paramname"><em>device</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> * </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>label</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Starts a new diagnostics_relay service on the specified device and connects to it. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
- <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>
- <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>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>DIAGNOSTICS_RELAY_E_SUCCESS on success, or an DIAGNOSTICS_RELAY_E_* error code otherwise. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ace004b6c06cf057ce6e2a52c5ef20f3e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_goodbye </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends the Goodbye request signaling the end of communication. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The diagnostics_relay client</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="aa940b00a740099fbef62169551c9cc9c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_request_diagnostics </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>type</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t * </td>
- <td class="paramname"><em>diagnostics</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Shutdown of the device and optionally show a user notification. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The diagnostics_relay client </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="ae2718e638b4d66c6da7271eda81181ea"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_restart </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>flags</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Restart the device and optionally show a user notification. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The diagnostics_relay client </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="ab056df27d421ca56559b99528acd51ff"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_shutdown </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>flags</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Shutdown of the device and optionally show a user notification. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The diagnostics_relay client </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a53dde7b6bc19417df267198f5356ae83"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="diagnostics__relay_8h.html#a7f980002ddc6e5396fb9fef14be9893e">diagnostics_relay_error_t</a> diagnostics_relay_sleep </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="diagnostics__relay_8h.html#a7a0213ab3558d483f2ca0a59ddf81311">diagnostics_relay_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Puts the device into deep sleep mode and disconnects from host. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The diagnostics_relay client</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.8
- </small></address>
- </body>
- </html>
|