heartbeat_8h.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
  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/heartbeat.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">heartbeat.h File Reference</div> </div>
  56. </div><!--header-->
  57. <div class="contents">
  58. <p>Send "heartbeat" to device to allow service connections over network.
  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:a51be2dfab509f59f8e6b0de60a6abbb4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51be2dfab509f59f8e6b0de60a6abbb4"></a>
  64. #define&#160;</td><td class="memItemRight" valign="bottom"><b>HEARTBEAT_SERVICE_NAME</b>&#160;&#160;&#160;&quot;com.apple.mobile.heartbeat&quot;</td></tr>
  65. <tr class="separator:a51be2dfab509f59f8e6b0de60a6abbb4"><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:a357bdf5b5f70d098eea9e2522a070c71"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a357bdf5b5f70d098eea9e2522a070c71"></a>
  70. typedef struct <br class="typebreak" />
  71. heartbeat_client_private&#160;</td><td class="memItemRight" valign="bottom"><b>heartbeat_client_private</b></td></tr>
  72. <tr class="separator:a357bdf5b5f70d098eea9e2522a070c71"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:ade9d2f30c28ec3c34d60ba636409abb9"><td class="memItemLeft" align="right" valign="top">typedef heartbeat_client_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a></td></tr>
  74. <tr class="memdesc:ade9d2f30c28ec3c34d60ba636409abb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle. <a href="#ade9d2f30c28ec3c34d60ba636409abb9">More...</a><br /></td></tr>
  75. <tr class="separator:ade9d2f30c28ec3c34d60ba636409abb9"><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:a9d62f6514ffeb1c73fbf685447e6dc75"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d62f6514ffeb1c73fbf685447e6dc75"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a> { <br />
  80. &#160;&#160;<b>HEARTBEAT_E_SUCCESS</b> = 0,
  81. <br />
  82. &#160;&#160;<b>HEARTBEAT_E_INVALID_ARG</b> = -1,
  83. <br />
  84. &#160;&#160;<b>HEARTBEAT_E_PLIST_ERROR</b> = -2,
  85. <br />
  86. &#160;&#160;<b>HEARTBEAT_E_MUX_ERROR</b> = -3,
  87. <br />
  88. &#160;&#160;<b>HEARTBEAT_E_SSL_ERROR</b> = -4,
  89. <br />
  90. &#160;&#160;<b>HEARTBEAT_E_UNKNOWN_ERROR</b> = -256
  91. <br />
  92. }</td></tr>
  93. <tr class="memdesc:a9d62f6514ffeb1c73fbf685447e6dc75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error Codes. <br /></td></tr>
  94. <tr class="separator:a9d62f6514ffeb1c73fbf685447e6dc75"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table><table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  97. Functions</h2></td></tr>
  98. <tr class="memitem:a8483e667ae7da8384121cccafc611527"><td class="memItemLeft" align="right" valign="top"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heartbeat_8h.html#a8483e667ae7da8384121cccafc611527">heartbeat_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a> *client)</td></tr>
  99. <tr class="memdesc:a8483e667ae7da8384121cccafc611527"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the heartbeat service on the specified device. <a href="#a8483e667ae7da8384121cccafc611527">More...</a><br /></td></tr>
  100. <tr class="separator:a8483e667ae7da8384121cccafc611527"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a78a52a7a856b3546fdc35c0b8ffc1237"><td class="memItemLeft" align="right" valign="top"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heartbeat_8h.html#a78a52a7a856b3546fdc35c0b8ffc1237">heartbeat_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a> *client, const char *label)</td></tr>
  102. <tr class="memdesc:a78a52a7a856b3546fdc35c0b8ffc1237"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a new heartbeat service on the specified device and connects to it. <a href="#a78a52a7a856b3546fdc35c0b8ffc1237">More...</a><br /></td></tr>
  103. <tr class="separator:a78a52a7a856b3546fdc35c0b8ffc1237"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ac61ccf0e726d2e8867d2d5c35ab50cd3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heartbeat_8h.html#ac61ccf0e726d2e8867d2d5c35ab50cd3">heartbeat_client_free</a> (<a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a> client)</td></tr>
  105. <tr class="memdesc:ac61ccf0e726d2e8867d2d5c35ab50cd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a heartbeat client from the device and frees up the heartbeat client data. <a href="#ac61ccf0e726d2e8867d2d5c35ab50cd3">More...</a><br /></td></tr>
  106. <tr class="separator:ac61ccf0e726d2e8867d2d5c35ab50cd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ad50741cdb9cf1253db51ee2d3b9d783d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heartbeat_8h.html#ad50741cdb9cf1253db51ee2d3b9d783d">heartbeat_send</a> (<a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a> client, plist_t plist)</td></tr>
  108. <tr class="memdesc:ad50741cdb9cf1253db51ee2d3b9d783d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a plist to the service. <a href="#ad50741cdb9cf1253db51ee2d3b9d783d">More...</a><br /></td></tr>
  109. <tr class="separator:ad50741cdb9cf1253db51ee2d3b9d783d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a4e5362af440d3ad0c98066049a079853"><td class="memItemLeft" align="right" valign="top"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heartbeat_8h.html#a4e5362af440d3ad0c98066049a079853">heartbeat_receive</a> (<a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a> client, plist_t *plist)</td></tr>
  111. <tr class="memdesc:a4e5362af440d3ad0c98066049a079853"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives a plist from the service. <a href="#a4e5362af440d3ad0c98066049a079853">More...</a><br /></td></tr>
  112. <tr class="separator:a4e5362af440d3ad0c98066049a079853"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a3266fca2d7e111f033c2ed1a8af356c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heartbeat_8h.html#a3266fca2d7e111f033c2ed1a8af356c7">heartbeat_receive_with_timeout</a> (<a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a> client, plist_t *plist, uint32_t timeout_ms)</td></tr>
  114. <tr class="memdesc:a3266fca2d7e111f033c2ed1a8af356c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives a plist using the given heartbeat client. <a href="#a3266fca2d7e111f033c2ed1a8af356c7">More...</a><br /></td></tr>
  115. <tr class="separator:a3266fca2d7e111f033c2ed1a8af356c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. </table>
  117. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  118. <div class="textblock"><p>Send "heartbeat" to device to allow service connections over network. </p>
  119. </div><h2 class="groupheader">Typedef Documentation</h2>
  120. <a class="anchor" id="ade9d2f30c28ec3c34d60ba636409abb9"></a>
  121. <div class="memitem">
  122. <div class="memproto">
  123. <table class="memname">
  124. <tr>
  125. <td class="memname">typedef heartbeat_client_private* <a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a></td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. <p>The client handle. </p>
  130. </div>
  131. </div>
  132. <h2 class="groupheader">Function Documentation</h2>
  133. <a class="anchor" id="ac61ccf0e726d2e8867d2d5c35ab50cd3"></a>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a> heartbeat_client_free </td>
  139. <td>(</td>
  140. <td class="paramtype"><a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a>&#160;</td>
  141. <td class="paramname"><em>client</em></td><td>)</td>
  142. <td></td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <p>Disconnects a heartbeat client from the device and frees up the heartbeat client data. </p>
  147. <dl class="params"><dt>Parameters</dt><dd>
  148. <table class="params">
  149. <tr><td class="paramname">client</td><td>The heartbeat client to disconnect and free.</td></tr>
  150. </table>
  151. </dd>
  152. </dl>
  153. <dl class="section return"><dt>Returns</dt><dd>HEARTBEAT_E_SUCCESS on success, HEARTBEAT_E_INVALID_ARG when client is NULL, or an HEARTBEAT_E_* error code otherwise. </dd></dl>
  154. </div>
  155. </div>
  156. <a class="anchor" id="a8483e667ae7da8384121cccafc611527"></a>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a> heartbeat_client_new </td>
  162. <td>(</td>
  163. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  164. <td class="paramname"><em>device</em>, </td>
  165. </tr>
  166. <tr>
  167. <td class="paramkey"></td>
  168. <td></td>
  169. <td class="paramtype">lockdownd_service_descriptor_t&#160;</td>
  170. <td class="paramname"><em>service</em>, </td>
  171. </tr>
  172. <tr>
  173. <td class="paramkey"></td>
  174. <td></td>
  175. <td class="paramtype"><a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a> *&#160;</td>
  176. <td class="paramname"><em>client</em>&#160;</td>
  177. </tr>
  178. <tr>
  179. <td></td>
  180. <td>)</td>
  181. <td></td><td></td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. <p>Connects to the heartbeat service on the specified device. </p>
  186. <dl class="params"><dt>Parameters</dt><dd>
  187. <table class="params">
  188. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  189. <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
  190. <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated heartbeat_client_t upon successful return. Must be freed using <a class="el" href="heartbeat_8h.html#ac61ccf0e726d2e8867d2d5c35ab50cd3" title="Disconnects a heartbeat client from the device and frees up the heartbeat client data. ">heartbeat_client_free()</a> after use.</td></tr>
  191. </table>
  192. </dd>
  193. </dl>
  194. <dl class="section return"><dt>Returns</dt><dd>HEARTBEAT_E_SUCCESS on success, HEARTBEAT_E_INVALID_ARG when client is NULL, or an HEARTBEAT_E_* error code otherwise. </dd></dl>
  195. </div>
  196. </div>
  197. <a class="anchor" id="a78a52a7a856b3546fdc35c0b8ffc1237"></a>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="memname">
  201. <tr>
  202. <td class="memname"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a> heartbeat_client_start_service </td>
  203. <td>(</td>
  204. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  205. <td class="paramname"><em>device</em>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype"><a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a> *&#160;</td>
  211. <td class="paramname"><em>client</em>, </td>
  212. </tr>
  213. <tr>
  214. <td class="paramkey"></td>
  215. <td></td>
  216. <td class="paramtype">const char *&#160;</td>
  217. <td class="paramname"><em>label</em>&#160;</td>
  218. </tr>
  219. <tr>
  220. <td></td>
  221. <td>)</td>
  222. <td></td><td></td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Starts a new heartbeat service on the specified device and connects to it. </p>
  227. <dl class="params"><dt>Parameters</dt><dd>
  228. <table class="params">
  229. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  230. <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated heartbeat_client_t upon successful return. Must be freed using <a class="el" href="heartbeat_8h.html#ac61ccf0e726d2e8867d2d5c35ab50cd3" title="Disconnects a heartbeat client from the device and frees up the heartbeat client data. ">heartbeat_client_free()</a> after use. </td></tr>
  231. <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>
  232. </table>
  233. </dd>
  234. </dl>
  235. <dl class="section return"><dt>Returns</dt><dd>HEARTBEAT_E_SUCCESS on success, or an HEARTBEAT_E_* error code otherwise. </dd></dl>
  236. </div>
  237. </div>
  238. <a class="anchor" id="a4e5362af440d3ad0c98066049a079853"></a>
  239. <div class="memitem">
  240. <div class="memproto">
  241. <table class="memname">
  242. <tr>
  243. <td class="memname"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a> heartbeat_receive </td>
  244. <td>(</td>
  245. <td class="paramtype"><a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a>&#160;</td>
  246. <td class="paramname"><em>client</em>, </td>
  247. </tr>
  248. <tr>
  249. <td class="paramkey"></td>
  250. <td></td>
  251. <td class="paramtype">plist_t *&#160;</td>
  252. <td class="paramname"><em>plist</em>&#160;</td>
  253. </tr>
  254. <tr>
  255. <td></td>
  256. <td>)</td>
  257. <td></td><td></td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. <p>Receives a plist from the service. </p>
  262. <dl class="params"><dt>Parameters</dt><dd>
  263. <table class="params">
  264. <tr><td class="paramname">client</td><td>The heartbeat client </td></tr>
  265. <tr><td class="paramname">plist</td><td>The plist to store the received data</td></tr>
  266. </table>
  267. </dd>
  268. </dl>
  269. <dl class="section return"><dt>Returns</dt><dd>HEARTBEAT_E_SUCCESS on success, HEARTBEAT_E_INVALID_ARG when client or plist is NULL </dd></dl>
  270. </div>
  271. </div>
  272. <a class="anchor" id="a3266fca2d7e111f033c2ed1a8af356c7"></a>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a> heartbeat_receive_with_timeout </td>
  278. <td>(</td>
  279. <td class="paramtype"><a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a>&#160;</td>
  280. <td class="paramname"><em>client</em>, </td>
  281. </tr>
  282. <tr>
  283. <td class="paramkey"></td>
  284. <td></td>
  285. <td class="paramtype">plist_t *&#160;</td>
  286. <td class="paramname"><em>plist</em>, </td>
  287. </tr>
  288. <tr>
  289. <td class="paramkey"></td>
  290. <td></td>
  291. <td class="paramtype">uint32_t&#160;</td>
  292. <td class="paramname"><em>timeout_ms</em>&#160;</td>
  293. </tr>
  294. <tr>
  295. <td></td>
  296. <td>)</td>
  297. <td></td><td></td>
  298. </tr>
  299. </table>
  300. </div><div class="memdoc">
  301. <p>Receives a plist using the given heartbeat client. </p>
  302. <dl class="params"><dt>Parameters</dt><dd>
  303. <table class="params">
  304. <tr><td class="paramname">client</td><td>The heartbeat client to use for receiving </td></tr>
  305. <tr><td class="paramname">plist</td><td>pointer to a plist_t that will point to the received plist upon successful return </td></tr>
  306. <tr><td class="paramname">timeout</td><td>Maximum time in milliseconds to wait for data.</td></tr>
  307. </table>
  308. </dd>
  309. </dl>
  310. <dl class="section return"><dt>Returns</dt><dd>HEARTBEAT_E_SUCCESS on success, HEARTBEAT_E_INVALID_ARG when client or *plist is NULL, HEARTBEAT_E_PLIST_ERROR when the received data cannot be converted to a plist, HEARTBEAT_E_MUX_ERROR when a communication error occurs, or HEARTBEAT_E_UNKNOWN_ERROR when an unspecified error occurs. </dd></dl>
  311. </div>
  312. </div>
  313. <a class="anchor" id="ad50741cdb9cf1253db51ee2d3b9d783d"></a>
  314. <div class="memitem">
  315. <div class="memproto">
  316. <table class="memname">
  317. <tr>
  318. <td class="memname"><a class="el" href="heartbeat_8h.html#a9d62f6514ffeb1c73fbf685447e6dc75">heartbeat_error_t</a> heartbeat_send </td>
  319. <td>(</td>
  320. <td class="paramtype"><a class="el" href="heartbeat_8h.html#ade9d2f30c28ec3c34d60ba636409abb9">heartbeat_client_t</a>&#160;</td>
  321. <td class="paramname"><em>client</em>, </td>
  322. </tr>
  323. <tr>
  324. <td class="paramkey"></td>
  325. <td></td>
  326. <td class="paramtype">plist_t&#160;</td>
  327. <td class="paramname"><em>plist</em>&#160;</td>
  328. </tr>
  329. <tr>
  330. <td></td>
  331. <td>)</td>
  332. <td></td><td></td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <p>Sends a plist to the service. </p>
  337. <dl class="params"><dt>Parameters</dt><dd>
  338. <table class="params">
  339. <tr><td class="paramname">client</td><td>The heartbeat client </td></tr>
  340. <tr><td class="paramname">plist</td><td>The plist to send</td></tr>
  341. </table>
  342. </dd>
  343. </dl>
  344. <dl class="section return"><dt>Returns</dt><dd>HEARTBEAT_E_SUCCESS on success, HEARTBEAT_E_INVALID_ARG when client or plist is NULL </dd></dl>
  345. </div>
  346. </div>
  347. </div><!-- contents -->
  348. <!-- start footer part -->
  349. <hr class="footer"/><address class="footer"><small>
  350. Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by &#160;<a href="http://www.doxygen.org/index.html">
  351. <img class="footer" src="doxygen.png" alt="doxygen"/>
  352. </a> 1.8.8
  353. </small></address>
  354. </body>
  355. </html>