file__relay_8h.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372
  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/file_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">file_relay.h File Reference</div> </div>
  56. </div><!--header-->
  57. <div class="contents">
  58. <p>Retrieve compressed CPIO archives.
  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:a734d26b64c2b4e4de79ed2a5042d7962"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a734d26b64c2b4e4de79ed2a5042d7962"></a>
  64. #define&#160;</td><td class="memItemRight" valign="bottom"><b>FILE_RELAY_SERVICE_NAME</b>&#160;&#160;&#160;&quot;com.apple.mobile.file_relay&quot;</td></tr>
  65. <tr class="separator:a734d26b64c2b4e4de79ed2a5042d7962"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. </table><table class="memberdecls">
  67. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  68. Typedefs</h2></td></tr>
  69. <tr class="memitem:a8605235172ab120f2334e1184f03189d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8605235172ab120f2334e1184f03189d"></a>
  70. typedef struct <br class="typebreak" />
  71. file_relay_client_private&#160;</td><td class="memItemRight" valign="bottom"><b>file_relay_client_private</b></td></tr>
  72. <tr class="separator:a8605235172ab120f2334e1184f03189d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:ab3be437eb59c3a5684ee572d554ac044"><td class="memItemLeft" align="right" valign="top">typedef file_relay_client_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a></td></tr>
  74. <tr class="memdesc:ab3be437eb59c3a5684ee572d554ac044"><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle. <a href="#ab3be437eb59c3a5684ee572d554ac044">More...</a><br /></td></tr>
  75. <tr class="separator:ab3be437eb59c3a5684ee572d554ac044"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. </table><table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  78. Enumerations</h2></td></tr>
  79. <tr class="memitem:a42ebdb0d27b59e9a757e0771a78ff175"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42ebdb0d27b59e9a757e0771a78ff175"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> { <br />
  80. &#160;&#160;<b>FILE_RELAY_E_SUCCESS</b> = 0,
  81. <br />
  82. &#160;&#160;<b>FILE_RELAY_E_INVALID_ARG</b> = -1,
  83. <br />
  84. &#160;&#160;<b>FILE_RELAY_E_PLIST_ERROR</b> = -2,
  85. <br />
  86. &#160;&#160;<b>FILE_RELAY_E_MUX_ERROR</b> = -3,
  87. <br />
  88. &#160;&#160;<b>FILE_RELAY_E_INVALID_SOURCE</b> = -4,
  89. <br />
  90. &#160;&#160;<b>FILE_RELAY_E_STAGING_EMPTY</b> = -5,
  91. <br />
  92. &#160;&#160;<b>FILE_RELAY_E_PERMISSION_DENIED</b> = -6,
  93. <br />
  94. &#160;&#160;<b>FILE_RELAY_E_UNKNOWN_ERROR</b> = -256
  95. <br />
  96. }</td></tr>
  97. <tr class="memdesc:a42ebdb0d27b59e9a757e0771a78ff175"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error Codes. <br /></td></tr>
  98. <tr class="separator:a42ebdb0d27b59e9a757e0771a78ff175"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table><table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  101. Functions</h2></td></tr>
  102. <tr class="memitem:ae84497b237b21987a0e7f981d6927a14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#ae84497b237b21987a0e7f981d6927a14">file_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="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> *client)</td></tr>
  103. <tr class="memdesc:ae84497b237b21987a0e7f981d6927a14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the file_relay service on the specified device. <a href="#ae84497b237b21987a0e7f981d6927a14">More...</a><br /></td></tr>
  104. <tr class="separator:ae84497b237b21987a0e7f981d6927a14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a53749f92d302587b5d2cee0faeb3a5e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#a53749f92d302587b5d2cee0faeb3a5e6">file_relay_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> *client, const char *label)</td></tr>
  106. <tr class="memdesc:a53749f92d302587b5d2cee0faeb3a5e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a new file_relay service on the specified device and connects to it. <a href="#a53749f92d302587b5d2cee0faeb3a5e6">More...</a><br /></td></tr>
  107. <tr class="separator:a53749f92d302587b5d2cee0faeb3a5e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a505e17a6a1184d65c0cb30119d169d2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#a505e17a6a1184d65c0cb30119d169d2b">file_relay_client_free</a> (<a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> client)</td></tr>
  109. <tr class="memdesc:a505e17a6a1184d65c0cb30119d169d2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a file_relay client from the device and frees up the file_relay client data. <a href="#a505e17a6a1184d65c0cb30119d169d2b">More...</a><br /></td></tr>
  110. <tr class="separator:a505e17a6a1184d65c0cb30119d169d2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:ab96cd1495725dd5adfd65573048cf86f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#ab96cd1495725dd5adfd65573048cf86f">file_relay_request_sources</a> (<a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> client, const char **sources, <a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> *connection)</td></tr>
  112. <tr class="memdesc:ab96cd1495725dd5adfd65573048cf86f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request data for the given sources. <a href="#ab96cd1495725dd5adfd65573048cf86f">More...</a><br /></td></tr>
  113. <tr class="separator:ab96cd1495725dd5adfd65573048cf86f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a946893f67f01002e1d0d00609e639ebb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="file__relay_8h.html#a946893f67f01002e1d0d00609e639ebb">file_relay_request_sources_timeout</a> (<a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> client, const char **sources, <a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> *connection, unsigned int timeout)</td></tr>
  115. <tr class="memdesc:a946893f67f01002e1d0d00609e639ebb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request data for the given sources. <a href="#a946893f67f01002e1d0d00609e639ebb">More...</a><br /></td></tr>
  116. <tr class="separator:a946893f67f01002e1d0d00609e639ebb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. </table>
  118. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  119. <div class="textblock"><p>Retrieve compressed CPIO archives. </p>
  120. </div><h2 class="groupheader">Typedef Documentation</h2>
  121. <a class="anchor" id="ab3be437eb59c3a5684ee572d554ac044"></a>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname">typedef file_relay_client_private* <a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a></td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>The client handle. </p>
  131. </div>
  132. </div>
  133. <h2 class="groupheader">Function Documentation</h2>
  134. <a class="anchor" id="a505e17a6a1184d65c0cb30119d169d2b"></a>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> file_relay_client_free </td>
  140. <td>(</td>
  141. <td class="paramtype"><a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a>&#160;</td>
  142. <td class="paramname"><em>client</em></td><td>)</td>
  143. <td></td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <p>Disconnects a file_relay client from the device and frees up the file_relay client data. </p>
  148. <dl class="params"><dt>Parameters</dt><dd>
  149. <table class="params">
  150. <tr><td class="paramname">client</td><td>The file_relay client to disconnect and free.</td></tr>
  151. </table>
  152. </dd>
  153. </dl>
  154. <dl class="section return"><dt>Returns</dt><dd>FILE_RELAY_E_SUCCESS on success, FILE_RELAY_E_INVALID_ARG when one of client or client-&gt;parent is invalid, or FILE_RELAY_E_UNKNOWN_ERROR when the was an error freeing the parent property_list_service client. </dd></dl>
  155. </div>
  156. </div>
  157. <a class="anchor" id="ae84497b237b21987a0e7f981d6927a14"></a>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> file_relay_client_new </td>
  163. <td>(</td>
  164. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  165. <td class="paramname"><em>device</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">lockdownd_service_descriptor_t&#160;</td>
  171. <td class="paramname"><em>service</em>, </td>
  172. </tr>
  173. <tr>
  174. <td class="paramkey"></td>
  175. <td></td>
  176. <td class="paramtype"><a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> *&#160;</td>
  177. <td class="paramname"><em>client</em>&#160;</td>
  178. </tr>
  179. <tr>
  180. <td></td>
  181. <td>)</td>
  182. <td></td><td></td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <p>Connects to the file_relay service on the specified device. </p>
  187. <dl class="params"><dt>Parameters</dt><dd>
  188. <table class="params">
  189. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  190. <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
  191. <tr><td class="paramname">client</td><td>Reference that will point to a newly allocated file_relay_client_t upon successful return.</td></tr>
  192. </table>
  193. </dd>
  194. </dl>
  195. <dl class="section return"><dt>Returns</dt><dd>FILE_RELAY_E_SUCCESS on success, FILE_RELAY_E_INVALID_ARG when one of the parameters is invalid, or FILE_RELAY_E_MUX_ERROR when the connection failed. </dd></dl>
  196. </div>
  197. </div>
  198. <a class="anchor" id="a53749f92d302587b5d2cee0faeb3a5e6"></a>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> file_relay_client_start_service </td>
  204. <td>(</td>
  205. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  206. <td class="paramname"><em>device</em>, </td>
  207. </tr>
  208. <tr>
  209. <td class="paramkey"></td>
  210. <td></td>
  211. <td class="paramtype"><a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a> *&#160;</td>
  212. <td class="paramname"><em>client</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype">const char *&#160;</td>
  218. <td class="paramname"><em>label</em>&#160;</td>
  219. </tr>
  220. <tr>
  221. <td></td>
  222. <td>)</td>
  223. <td></td><td></td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Starts a new file_relay service on the specified device and connects to it. </p>
  228. <dl class="params"><dt>Parameters</dt><dd>
  229. <table class="params">
  230. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  231. <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated file_relay_client_t upon successful return. Must be freed using <a class="el" href="file__relay_8h.html#a505e17a6a1184d65c0cb30119d169d2b" title="Disconnects a file_relay client from the device and frees up the file_relay client data...">file_relay_client_free()</a> after use. </td></tr>
  232. <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>
  233. </table>
  234. </dd>
  235. </dl>
  236. <dl class="section return"><dt>Returns</dt><dd>FILE_RELAY_E_SUCCESS on success, or an FILE_RELAY_E_* error code otherwise. </dd></dl>
  237. </div>
  238. </div>
  239. <a class="anchor" id="ab96cd1495725dd5adfd65573048cf86f"></a>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> file_relay_request_sources </td>
  245. <td>(</td>
  246. <td class="paramtype"><a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a>&#160;</td>
  247. <td class="paramname"><em>client</em>, </td>
  248. </tr>
  249. <tr>
  250. <td class="paramkey"></td>
  251. <td></td>
  252. <td class="paramtype">const char **&#160;</td>
  253. <td class="paramname"><em>sources</em>, </td>
  254. </tr>
  255. <tr>
  256. <td class="paramkey"></td>
  257. <td></td>
  258. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> *&#160;</td>
  259. <td class="paramname"><em>connection</em>&#160;</td>
  260. </tr>
  261. <tr>
  262. <td></td>
  263. <td>)</td>
  264. <td></td><td></td>
  265. </tr>
  266. </table>
  267. </div><div class="memdoc">
  268. <p>Request data for the given sources. </p>
  269. <dl class="params"><dt>Parameters</dt><dd>
  270. <table class="params">
  271. <tr><td class="paramname">client</td><td>The connected file_relay client. </td></tr>
  272. <tr><td class="paramname">sources</td><td>A NULL-terminated list of sources to retrieve. Valid sources are:<ul>
  273. <li>AppleSupport</li>
  274. <li>Network</li>
  275. <li>VPN</li>
  276. <li>WiFi</li>
  277. <li>UserDatabases</li>
  278. <li>CrashReporter</li>
  279. <li>tmp</li>
  280. <li>SystemConfiguration </li>
  281. </ul>
  282. </td></tr>
  283. <tr><td class="paramname">connection</td><td>The connection that has to be used for receiving the data using <a class="el" href="libimobiledevice_8h.html#a0f40ec458db4f77449f67e41bd14170d" title="Receive data from a device via the given connection. ">idevice_connection_receive()</a>. The connection will be closed automatically by the device, but use <a class="el" href="file__relay_8h.html#a505e17a6a1184d65c0cb30119d169d2b" title="Disconnects a file_relay client from the device and frees up the file_relay client data...">file_relay_client_free()</a> to clean up properly. </td></tr>
  284. <tr><td class="paramname">timeout</td><td>Maximum time in milliseconds to wait for data.</td></tr>
  285. </table>
  286. </dd>
  287. </dl>
  288. <dl class="section note"><dt>Note</dt><dd>WARNING: Don't call this function without reading the data afterwards. A directory mobile_file_relay.XXXX used for creating the archive will remain in the /tmp directory otherwise.</dd></dl>
  289. <dl class="section return"><dt>Returns</dt><dd>FILE_RELAY_E_SUCCESS on succes, FILE_RELAY_E_INVALID_ARG when one or more parameters are invalid, FILE_RELAY_E_MUX_ERROR if a communication error occurs, FILE_RELAY_E_PLIST_ERROR when the received result is NULL or is not a valid plist, FILE_RELAY_E_INVALID_SOURCE if one or more sources are invalid, FILE_RELAY_E_STAGING_EMPTY if no data is available for the given sources, or FILE_RELAY_E_UNKNOWN_ERROR otherwise. </dd></dl>
  290. </div>
  291. </div>
  292. <a class="anchor" id="a946893f67f01002e1d0d00609e639ebb"></a>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname"><a class="el" href="file__relay_8h.html#a42ebdb0d27b59e9a757e0771a78ff175">file_relay_error_t</a> file_relay_request_sources_timeout </td>
  298. <td>(</td>
  299. <td class="paramtype"><a class="el" href="file__relay_8h.html#ab3be437eb59c3a5684ee572d554ac044">file_relay_client_t</a>&#160;</td>
  300. <td class="paramname"><em>client</em>, </td>
  301. </tr>
  302. <tr>
  303. <td class="paramkey"></td>
  304. <td></td>
  305. <td class="paramtype">const char **&#160;</td>
  306. <td class="paramname"><em>sources</em>, </td>
  307. </tr>
  308. <tr>
  309. <td class="paramkey"></td>
  310. <td></td>
  311. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#a01e577b2574f08fb2f252607e274ba1b">idevice_connection_t</a> *&#160;</td>
  312. <td class="paramname"><em>connection</em>, </td>
  313. </tr>
  314. <tr>
  315. <td class="paramkey"></td>
  316. <td></td>
  317. <td class="paramtype">unsigned int&#160;</td>
  318. <td class="paramname"><em>timeout</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>Request data for the given sources. </p>
  328. <p>Calls <a class="el" href="file__relay_8h.html#a946893f67f01002e1d0d00609e639ebb" title="Request data for the given sources. ">file_relay_request_sources_timeout()</a> with a timeout of 60000 milliseconds (60 seconds).</p>
  329. <dl class="params"><dt>Parameters</dt><dd>
  330. <table class="params">
  331. <tr><td class="paramname">client</td><td>The connected file_relay client. </td></tr>
  332. <tr><td class="paramname">sources</td><td>A NULL-terminated list of sources to retrieve. Valid sources are:<ul>
  333. <li>AppleSupport</li>
  334. <li>Network</li>
  335. <li>VPN</li>
  336. <li>WiFi</li>
  337. <li>UserDatabases</li>
  338. <li>CrashReporter</li>
  339. <li>tmp</li>
  340. <li>SystemConfiguration </li>
  341. </ul>
  342. </td></tr>
  343. <tr><td class="paramname">connection</td><td>The connection that has to be used for receiving the data using <a class="el" href="libimobiledevice_8h.html#a0f40ec458db4f77449f67e41bd14170d" title="Receive data from a device via the given connection. ">idevice_connection_receive()</a>. The connection will be closed automatically by the device, but use <a class="el" href="file__relay_8h.html#a505e17a6a1184d65c0cb30119d169d2b" title="Disconnects a file_relay client from the device and frees up the file_relay client data...">file_relay_client_free()</a> to clean up properly.</td></tr>
  344. </table>
  345. </dd>
  346. </dl>
  347. <dl class="section note"><dt>Note</dt><dd>WARNING: Don't call this function without reading the data afterwards. A directory mobile_file_relay.XXXX used for creating the archive will remain in the /tmp directory otherwise.</dd></dl>
  348. <dl class="section return"><dt>Returns</dt><dd>FILE_RELAY_E_SUCCESS on succes, FILE_RELAY_E_INVALID_ARG when one or more parameters are invalid, FILE_RELAY_E_MUX_ERROR if a communication error occurs, FILE_RELAY_E_PLIST_ERROR when the received result is NULL or is not a valid plist, FILE_RELAY_E_INVALID_SOURCE if one or more sources are invalid, FILE_RELAY_E_STAGING_EMPTY if no data is available for the given sources, or FILE_RELAY_E_UNKNOWN_ERROR otherwise. </dd></dl>
  349. </div>
  350. </div>
  351. </div><!-- contents -->
  352. <!-- start footer part -->
  353. <hr class="footer"/><address class="footer"><small>
  354. Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by &#160;<a href="http://www.doxygen.org/index.html">
  355. <img class="footer" src="doxygen.png" alt="doxygen"/>
  356. </a> 1.8.8
  357. </small></address>
  358. </body>
  359. </html>