syslog__relay_8h.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  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/syslog_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">syslog_relay.h File Reference</div> </div>
  56. </div><!--header-->
  57. <div class="contents">
  58. <p>Capture the syslog output from a 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:a92562db5b72967e7d2fb29873e98e0c5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92562db5b72967e7d2fb29873e98e0c5"></a>
  64. #define&#160;</td><td class="memItemRight" valign="bottom"><b>SYSLOG_RELAY_SERVICE_NAME</b>&#160;&#160;&#160;&quot;com.apple.syslog_relay&quot;</td></tr>
  65. <tr class="separator:a92562db5b72967e7d2fb29873e98e0c5"><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:a882a90c33862ac059c9c65d0a67cc2fb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a882a90c33862ac059c9c65d0a67cc2fb"></a>
  70. typedef struct <br class="typebreak" />
  71. syslog_relay_client_private&#160;</td><td class="memItemRight" valign="bottom"><b>syslog_relay_client_private</b></td></tr>
  72. <tr class="separator:a882a90c33862ac059c9c65d0a67cc2fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:aa460066cb415ed01632f49ed32c0ba18"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
  74. syslog_relay_client_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a></td></tr>
  75. <tr class="memdesc:aa460066cb415ed01632f49ed32c0ba18"><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle. <a href="#aa460066cb415ed01632f49ed32c0ba18">More...</a><br /></td></tr>
  76. <tr class="separator:aa460066cb415ed01632f49ed32c0ba18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:aa2c4c793f1735c4165d263a9345ef1a2"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslog__relay_8h.html#aa2c4c793f1735c4165d263a9345ef1a2">syslog_relay_receive_cb_t</a> )(char c, void *user_data)</td></tr>
  78. <tr class="memdesc:aa2c4c793f1735c4165d263a9345ef1a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives each character received from the device. <a href="#aa2c4c793f1735c4165d263a9345ef1a2">More...</a><br /></td></tr>
  79. <tr class="separator:aa2c4c793f1735c4165d263a9345ef1a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. </table><table class="memberdecls">
  81. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  82. Enumerations</h2></td></tr>
  83. <tr class="memitem:a9a712c417015ef1ccd29fa7e6d2e66e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a712c417015ef1ccd29fa7e6d2e66e7"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> { <br />
  84. &#160;&#160;<b>SYSLOG_RELAY_E_SUCCESS</b> = 0,
  85. <br />
  86. &#160;&#160;<b>SYSLOG_RELAY_E_INVALID_ARG</b> = -1,
  87. <br />
  88. &#160;&#160;<b>SYSLOG_RELAY_E_MUX_ERROR</b> = -2,
  89. <br />
  90. &#160;&#160;<b>SYSLOG_RELAY_E_SSL_ERROR</b> = -3,
  91. <br />
  92. &#160;&#160;<b>SYSLOG_RELAY_E_UNKNOWN_ERROR</b> = -256
  93. <br />
  94. }</td></tr>
  95. <tr class="memdesc:a9a712c417015ef1ccd29fa7e6d2e66e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error Codes. <br /></td></tr>
  96. <tr class="separator:a9a712c417015ef1ccd29fa7e6d2e66e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table><table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  99. Functions</h2></td></tr>
  100. <tr class="memitem:a727a0f74b0e137fd4fd13cf94899ebd0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslog__relay_8h.html#a727a0f74b0e137fd4fd13cf94899ebd0">syslog_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="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> *client)</td></tr>
  101. <tr class="memdesc:a727a0f74b0e137fd4fd13cf94899ebd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the syslog_relay service on the specified device. <a href="#a727a0f74b0e137fd4fd13cf94899ebd0">More...</a><br /></td></tr>
  102. <tr class="separator:a727a0f74b0e137fd4fd13cf94899ebd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:ac163d51d786fbc01ac5d71e25efa7060"><td class="memItemLeft" align="right" valign="top"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslog__relay_8h.html#ac163d51d786fbc01ac5d71e25efa7060">syslog_relay_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> *client, const char *label)</td></tr>
  104. <tr class="memdesc:ac163d51d786fbc01ac5d71e25efa7060"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a new syslog_relay service on the specified device and connects to it. <a href="#ac163d51d786fbc01ac5d71e25efa7060">More...</a><br /></td></tr>
  105. <tr class="separator:ac163d51d786fbc01ac5d71e25efa7060"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a4989b229a132ba162cb742dceee801f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslog__relay_8h.html#a4989b229a132ba162cb742dceee801f7">syslog_relay_client_free</a> (<a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> client)</td></tr>
  107. <tr class="memdesc:a4989b229a132ba162cb742dceee801f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a syslog_relay client from the device and frees up the syslog_relay client data. <a href="#a4989b229a132ba162cb742dceee801f7">More...</a><br /></td></tr>
  108. <tr class="separator:a4989b229a132ba162cb742dceee801f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:ad97df768574b94cc9fad0dd70db4702b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslog__relay_8h.html#ad97df768574b94cc9fad0dd70db4702b">syslog_relay_start_capture</a> (<a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> client, <a class="el" href="syslog__relay_8h.html#aa2c4c793f1735c4165d263a9345ef1a2">syslog_relay_receive_cb_t</a> callback, void *user_data)</td></tr>
  110. <tr class="memdesc:ad97df768574b94cc9fad0dd70db4702b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts capturing the syslog of the device using a callback. <a href="#ad97df768574b94cc9fad0dd70db4702b">More...</a><br /></td></tr>
  111. <tr class="separator:ad97df768574b94cc9fad0dd70db4702b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a0b231a01e41305227f90f40e9d74aeca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslog__relay_8h.html#a0b231a01e41305227f90f40e9d74aeca">syslog_relay_stop_capture</a> (<a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> client)</td></tr>
  113. <tr class="memdesc:a0b231a01e41305227f90f40e9d74aeca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops capturing the syslog of the device. <a href="#a0b231a01e41305227f90f40e9d74aeca">More...</a><br /></td></tr>
  114. <tr class="separator:a0b231a01e41305227f90f40e9d74aeca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:aced54910a322ae64952b9a8c9cb2f6b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslog__relay_8h.html#aced54910a322ae64952b9a8c9cb2f6b5">syslog_relay_receive_with_timeout</a> (<a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> client, char *data, uint32_t size, uint32_t *received, unsigned int timeout)</td></tr>
  116. <tr class="memdesc:aced54910a322ae64952b9a8c9cb2f6b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives data using the given syslog_relay client with specified timeout. <a href="#aced54910a322ae64952b9a8c9cb2f6b5">More...</a><br /></td></tr>
  117. <tr class="separator:aced54910a322ae64952b9a8c9cb2f6b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a2543d1c8823b8202a089a6acbaa03845"><td class="memItemLeft" align="right" valign="top"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="syslog__relay_8h.html#a2543d1c8823b8202a089a6acbaa03845">syslog_relay_receive</a> (<a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> client, char *data, uint32_t size, uint32_t *received)</td></tr>
  119. <tr class="memdesc:a2543d1c8823b8202a089a6acbaa03845"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives data from the service. <a href="#a2543d1c8823b8202a089a6acbaa03845">More...</a><br /></td></tr>
  120. <tr class="separator:a2543d1c8823b8202a089a6acbaa03845"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table>
  122. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  123. <div class="textblock"><p>Capture the syslog output from a device. </p>
  124. </div><h2 class="groupheader">Typedef Documentation</h2>
  125. <a class="anchor" id="aa460066cb415ed01632f49ed32c0ba18"></a>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">typedef syslog_relay_client_private* <a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a></td>
  131. </tr>
  132. </table>
  133. </div><div class="memdoc">
  134. <p>The client handle. </p>
  135. </div>
  136. </div>
  137. <a class="anchor" id="aa2c4c793f1735c4165d263a9345ef1a2"></a>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">typedef void(* syslog_relay_receive_cb_t)(char c, void *user_data)</td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <p>Receives each character received from the device. </p>
  147. </div>
  148. </div>
  149. <h2 class="groupheader">Function Documentation</h2>
  150. <a class="anchor" id="a4989b229a132ba162cb742dceee801f7"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_relay_client_free </td>
  156. <td>(</td>
  157. <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a>&#160;</td>
  158. <td class="paramname"><em>client</em></td><td>)</td>
  159. <td></td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. <p>Disconnects a syslog_relay client from the device and frees up the syslog_relay client data. </p>
  164. <dl class="params"><dt>Parameters</dt><dd>
  165. <table class="params">
  166. <tr><td class="paramname">client</td><td>The syslog_relay client to disconnect and free.</td></tr>
  167. </table>
  168. </dd>
  169. </dl>
  170. <dl class="section return"><dt>Returns</dt><dd>SYSLOG_RELAY_E_SUCCESS on success, SYSLOG_RELAY_E_INVALID_ARG when client is NULL, or an SYSLOG_RELAY_E_* error code otherwise. </dd></dl>
  171. </div>
  172. </div>
  173. <a class="anchor" id="a727a0f74b0e137fd4fd13cf94899ebd0"></a>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_relay_client_new </td>
  179. <td>(</td>
  180. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  181. <td class="paramname"><em>device</em>, </td>
  182. </tr>
  183. <tr>
  184. <td class="paramkey"></td>
  185. <td></td>
  186. <td class="paramtype">lockdownd_service_descriptor_t&#160;</td>
  187. <td class="paramname"><em>service</em>, </td>
  188. </tr>
  189. <tr>
  190. <td class="paramkey"></td>
  191. <td></td>
  192. <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> *&#160;</td>
  193. <td class="paramname"><em>client</em>&#160;</td>
  194. </tr>
  195. <tr>
  196. <td></td>
  197. <td>)</td>
  198. <td></td><td></td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Connects to the syslog_relay service on the specified device. </p>
  203. <dl class="params"><dt>Parameters</dt><dd>
  204. <table class="params">
  205. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  206. <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
  207. <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated syslog_relay_client_t upon successful return. Must be freed using <a class="el" href="syslog__relay_8h.html#a4989b229a132ba162cb742dceee801f7" title="Disconnects a syslog_relay client from the device and frees up the syslog_relay client data...">syslog_relay_client_free()</a> after use.</td></tr>
  208. </table>
  209. </dd>
  210. </dl>
  211. <dl class="section return"><dt>Returns</dt><dd>SYSLOG_RELAY_E_SUCCESS on success, SYSLOG_RELAY_E_INVALID_ARG when client is NULL, or an SYSLOG_RELAY_E_* error code otherwise. </dd></dl>
  212. </div>
  213. </div>
  214. <a class="anchor" id="ac163d51d786fbc01ac5d71e25efa7060"></a>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_relay_client_start_service </td>
  220. <td>(</td>
  221. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  222. <td class="paramname"><em>device</em>, </td>
  223. </tr>
  224. <tr>
  225. <td class="paramkey"></td>
  226. <td></td>
  227. <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> *&#160;</td>
  228. <td class="paramname"><em>client</em>, </td>
  229. </tr>
  230. <tr>
  231. <td class="paramkey"></td>
  232. <td></td>
  233. <td class="paramtype">const char *&#160;</td>
  234. <td class="paramname"><em>label</em>&#160;</td>
  235. </tr>
  236. <tr>
  237. <td></td>
  238. <td>)</td>
  239. <td></td><td></td>
  240. </tr>
  241. </table>
  242. </div><div class="memdoc">
  243. <p>Starts a new syslog_relay service on the specified device and connects to it. </p>
  244. <dl class="params"><dt>Parameters</dt><dd>
  245. <table class="params">
  246. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  247. <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated syslog_relay_client_t upon successful return. Must be freed using <a class="el" href="syslog__relay_8h.html#a4989b229a132ba162cb742dceee801f7" title="Disconnects a syslog_relay client from the device and frees up the syslog_relay client data...">syslog_relay_client_free()</a> after use. </td></tr>
  248. <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>
  249. </table>
  250. </dd>
  251. </dl>
  252. <dl class="section return"><dt>Returns</dt><dd>SYSLOG_RELAY_E_SUCCESS on success, or an SYSLOG_RELAY_E_* error code otherwise. </dd></dl>
  253. </div>
  254. </div>
  255. <a class="anchor" id="a2543d1c8823b8202a089a6acbaa03845"></a>
  256. <div class="memitem">
  257. <div class="memproto">
  258. <table class="memname">
  259. <tr>
  260. <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_relay_receive </td>
  261. <td>(</td>
  262. <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a>&#160;</td>
  263. <td class="paramname"><em>client</em>, </td>
  264. </tr>
  265. <tr>
  266. <td class="paramkey"></td>
  267. <td></td>
  268. <td class="paramtype">char *&#160;</td>
  269. <td class="paramname"><em>data</em>, </td>
  270. </tr>
  271. <tr>
  272. <td class="paramkey"></td>
  273. <td></td>
  274. <td class="paramtype">uint32_t&#160;</td>
  275. <td class="paramname"><em>size</em>, </td>
  276. </tr>
  277. <tr>
  278. <td class="paramkey"></td>
  279. <td></td>
  280. <td class="paramtype">uint32_t *&#160;</td>
  281. <td class="paramname"><em>received</em>&#160;</td>
  282. </tr>
  283. <tr>
  284. <td></td>
  285. <td>)</td>
  286. <td></td><td></td>
  287. </tr>
  288. </table>
  289. </div><div class="memdoc">
  290. <p>Receives data from the service. </p>
  291. <dl class="params"><dt>Parameters</dt><dd>
  292. <table class="params">
  293. <tr><td class="paramname">client</td><td>The syslog_relay client </td></tr>
  294. <tr><td class="paramname">data</td><td>Buffer that will be filled with the data received </td></tr>
  295. <tr><td class="paramname">size</td><td>Number of bytes to receive </td></tr>
  296. <tr><td class="paramname">received</td><td>Number of bytes received (can be NULL to ignore) </td></tr>
  297. <tr><td class="paramname">timeout</td><td>Maximum time in milliseconds to wait for data.</td></tr>
  298. </table>
  299. </dd>
  300. </dl>
  301. <dl class="section return"><dt>Returns</dt><dd>SYSLOG_RELAY_E_SUCCESS on success, SYSLOG_RELAY_E_INVALID_ARG when client or plist is NULL </dd></dl>
  302. </div>
  303. </div>
  304. <a class="anchor" id="aced54910a322ae64952b9a8c9cb2f6b5"></a>
  305. <div class="memitem">
  306. <div class="memproto">
  307. <table class="memname">
  308. <tr>
  309. <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_relay_receive_with_timeout </td>
  310. <td>(</td>
  311. <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a>&#160;</td>
  312. <td class="paramname"><em>client</em>, </td>
  313. </tr>
  314. <tr>
  315. <td class="paramkey"></td>
  316. <td></td>
  317. <td class="paramtype">char *&#160;</td>
  318. <td class="paramname"><em>data</em>, </td>
  319. </tr>
  320. <tr>
  321. <td class="paramkey"></td>
  322. <td></td>
  323. <td class="paramtype">uint32_t&#160;</td>
  324. <td class="paramname"><em>size</em>, </td>
  325. </tr>
  326. <tr>
  327. <td class="paramkey"></td>
  328. <td></td>
  329. <td class="paramtype">uint32_t *&#160;</td>
  330. <td class="paramname"><em>received</em>, </td>
  331. </tr>
  332. <tr>
  333. <td class="paramkey"></td>
  334. <td></td>
  335. <td class="paramtype">unsigned int&#160;</td>
  336. <td class="paramname"><em>timeout</em>&#160;</td>
  337. </tr>
  338. <tr>
  339. <td></td>
  340. <td>)</td>
  341. <td></td><td></td>
  342. </tr>
  343. </table>
  344. </div><div class="memdoc">
  345. <p>Receives data using the given syslog_relay client with specified timeout. </p>
  346. <dl class="params"><dt>Parameters</dt><dd>
  347. <table class="params">
  348. <tr><td class="paramname">client</td><td>The syslog_relay client to use for receiving </td></tr>
  349. <tr><td class="paramname">data</td><td>Buffer that will be filled with the data received </td></tr>
  350. <tr><td class="paramname">size</td><td>Number of bytes to receive </td></tr>
  351. <tr><td class="paramname">received</td><td>Number of bytes received (can be NULL to ignore) </td></tr>
  352. <tr><td class="paramname">timeout</td><td>Maximum time in milliseconds to wait for data.</td></tr>
  353. </table>
  354. </dd>
  355. </dl>
  356. <dl class="section return"><dt>Returns</dt><dd>SYSLOG_RELAY_E_SUCCESS on success, SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are invalid, SYSLOG_RELAY_E_MUX_ERROR when a communication error occurs, or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified error occurs. </dd></dl>
  357. </div>
  358. </div>
  359. <a class="anchor" id="ad97df768574b94cc9fad0dd70db4702b"></a>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <table class="memname">
  363. <tr>
  364. <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_relay_start_capture </td>
  365. <td>(</td>
  366. <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a>&#160;</td>
  367. <td class="paramname"><em>client</em>, </td>
  368. </tr>
  369. <tr>
  370. <td class="paramkey"></td>
  371. <td></td>
  372. <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa2c4c793f1735c4165d263a9345ef1a2">syslog_relay_receive_cb_t</a>&#160;</td>
  373. <td class="paramname"><em>callback</em>, </td>
  374. </tr>
  375. <tr>
  376. <td class="paramkey"></td>
  377. <td></td>
  378. <td class="paramtype">void *&#160;</td>
  379. <td class="paramname"><em>user_data</em>&#160;</td>
  380. </tr>
  381. <tr>
  382. <td></td>
  383. <td>)</td>
  384. <td></td><td></td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <p>Starts capturing the syslog of the device using a callback. </p>
  389. <p>Use <a class="el" href="syslog__relay_8h.html#a0b231a01e41305227f90f40e9d74aeca" title="Stops capturing the syslog of the device. ">syslog_relay_stop_capture()</a> to stop receiving the syslog.</p>
  390. <dl class="params"><dt>Parameters</dt><dd>
  391. <table class="params">
  392. <tr><td class="paramname">client</td><td>The syslog_relay client to use </td></tr>
  393. <tr><td class="paramname">callback</td><td>Callback to receive each character from the syslog. </td></tr>
  394. <tr><td class="paramname">user_data</td><td>Custom pointer passed to the callback function.</td></tr>
  395. </table>
  396. </dd>
  397. </dl>
  398. <dl class="section return"><dt>Returns</dt><dd>SYSLOG_RELAY_E_SUCCESS on success, SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are invalid or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified error occurs or a syslog capture has already been started. </dd></dl>
  399. </div>
  400. </div>
  401. <a class="anchor" id="a0b231a01e41305227f90f40e9d74aeca"></a>
  402. <div class="memitem">
  403. <div class="memproto">
  404. <table class="memname">
  405. <tr>
  406. <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_relay_stop_capture </td>
  407. <td>(</td>
  408. <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a>&#160;</td>
  409. <td class="paramname"><em>client</em></td><td>)</td>
  410. <td></td>
  411. </tr>
  412. </table>
  413. </div><div class="memdoc">
  414. <p>Stops capturing the syslog of the device. </p>
  415. <p>Use <a class="el" href="syslog__relay_8h.html#ad97df768574b94cc9fad0dd70db4702b" title="Starts capturing the syslog of the device using a callback. ">syslog_relay_start_capture()</a> to start receiving the syslog.</p>
  416. <dl class="params"><dt>Parameters</dt><dd>
  417. <table class="params">
  418. <tr><td class="paramname">client</td><td>The syslog_relay client to use</td></tr>
  419. </table>
  420. </dd>
  421. </dl>
  422. <dl class="section return"><dt>Returns</dt><dd>SYSLOG_RELAY_E_SUCCESS on success, SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are invalid or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified error occurs or a syslog capture has already been started. </dd></dl>
  423. </div>
  424. </div>
  425. </div><!-- contents -->
  426. <!-- start footer part -->
  427. <hr class="footer"/><address class="footer"><small>
  428. Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by &#160;<a href="http://www.doxygen.org/index.html">
  429. <img class="footer" src="doxygen.png" alt="doxygen"/>
  430. </a> 1.8.8
  431. </small></address>
  432. </body>
  433. </html>