| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452 |
- <!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/syslog_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">syslog_relay.h File Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Capture the syslog output from a 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:a92562db5b72967e7d2fb29873e98e0c5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92562db5b72967e7d2fb29873e98e0c5"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>SYSLOG_RELAY_SERVICE_NAME</b>   "com.apple.syslog_relay"</td></tr>
- <tr class="separator:a92562db5b72967e7d2fb29873e98e0c5"><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:a882a90c33862ac059c9c65d0a67cc2fb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a882a90c33862ac059c9c65d0a67cc2fb"></a>
- typedef struct <br class="typebreak" />
- syslog_relay_client_private </td><td class="memItemRight" valign="bottom"><b>syslog_relay_client_private</b></td></tr>
- <tr class="separator:a882a90c33862ac059c9c65d0a67cc2fb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa460066cb415ed01632f49ed32c0ba18"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
- syslog_relay_client_private * </td><td class="memItemRight" valign="bottom"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a></td></tr>
- <tr class="memdesc:aa460066cb415ed01632f49ed32c0ba18"><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#aa460066cb415ed01632f49ed32c0ba18">More...</a><br /></td></tr>
- <tr class="separator:aa460066cb415ed01632f49ed32c0ba18"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa2c4c793f1735c4165d263a9345ef1a2"><td class="memItemLeft" align="right" valign="top">typedef void(* </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>
- <tr class="memdesc:aa2c4c793f1735c4165d263a9345ef1a2"><td class="mdescLeft"> </td><td class="mdescRight">Receives each character received from the device. <a href="#aa2c4c793f1735c4165d263a9345ef1a2">More...</a><br /></td></tr>
- <tr class="separator:aa2c4c793f1735c4165d263a9345ef1a2"><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:a9a712c417015ef1ccd29fa7e6d2e66e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a712c417015ef1ccd29fa7e6d2e66e7"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> { <br />
-   <b>SYSLOG_RELAY_E_SUCCESS</b> = 0,
- <br />
-   <b>SYSLOG_RELAY_E_INVALID_ARG</b> = -1,
- <br />
-   <b>SYSLOG_RELAY_E_MUX_ERROR</b> = -2,
- <br />
-   <b>SYSLOG_RELAY_E_SSL_ERROR</b> = -3,
- <br />
-   <b>SYSLOG_RELAY_E_UNKNOWN_ERROR</b> = -256
- <br />
- }</td></tr>
- <tr class="memdesc:a9a712c417015ef1ccd29fa7e6d2e66e7"><td class="mdescLeft"> </td><td class="mdescRight">Error Codes. <br /></td></tr>
- <tr class="separator:a9a712c417015ef1ccd29fa7e6d2e66e7"><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:a727a0f74b0e137fd4fd13cf94899ebd0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> </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>
- <tr class="memdesc:a727a0f74b0e137fd4fd13cf94899ebd0"><td class="mdescLeft"> </td><td class="mdescRight">Connects to the syslog_relay service on the specified device. <a href="#a727a0f74b0e137fd4fd13cf94899ebd0">More...</a><br /></td></tr>
- <tr class="separator:a727a0f74b0e137fd4fd13cf94899ebd0"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:ac163d51d786fbc01ac5d71e25efa7060"><td class="mdescLeft"> </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>
- <tr class="separator:ac163d51d786fbc01ac5d71e25efa7060"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:a4989b229a132ba162cb742dceee801f7"><td class="mdescLeft"> </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>
- <tr class="separator:a4989b229a132ba162cb742dceee801f7"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:ad97df768574b94cc9fad0dd70db4702b"><td class="mdescLeft"> </td><td class="mdescRight">Starts capturing the syslog of the device using a callback. <a href="#ad97df768574b94cc9fad0dd70db4702b">More...</a><br /></td></tr>
- <tr class="separator:ad97df768574b94cc9fad0dd70db4702b"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:a0b231a01e41305227f90f40e9d74aeca"><td class="mdescLeft"> </td><td class="mdescRight">Stops capturing the syslog of the device. <a href="#a0b231a01e41305227f90f40e9d74aeca">More...</a><br /></td></tr>
- <tr class="separator:a0b231a01e41305227f90f40e9d74aeca"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:aced54910a322ae64952b9a8c9cb2f6b5"><td class="mdescLeft"> </td><td class="mdescRight">Receives data using the given syslog_relay client with specified timeout. <a href="#aced54910a322ae64952b9a8c9cb2f6b5">More...</a><br /></td></tr>
- <tr class="separator:aced54910a322ae64952b9a8c9cb2f6b5"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:a2543d1c8823b8202a089a6acbaa03845"><td class="mdescLeft"> </td><td class="mdescRight">Receives data from the service. <a href="#a2543d1c8823b8202a089a6acbaa03845">More...</a><br /></td></tr>
- <tr class="separator:a2543d1c8823b8202a089a6acbaa03845"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Capture the syslog output from a device. </p>
- </div><h2 class="groupheader">Typedef Documentation</h2>
- <a class="anchor" id="aa460066cb415ed01632f49ed32c0ba18"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef syslog_relay_client_private* <a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The client handle. </p>
- </div>
- </div>
- <a class="anchor" id="aa2c4c793f1735c4165d263a9345ef1a2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef void(* syslog_relay_receive_cb_t)(char c, void *user_data)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Receives each character received from the device. </p>
- </div>
- </div>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="a4989b229a132ba162cb742dceee801f7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_relay_client_free </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_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 syslog_relay client from the device and frees up the syslog_relay client data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The syslog_relay client to disconnect and free.</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a727a0f74b0e137fd4fd13cf94899ebd0"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_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="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_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 syslog_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>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>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="ac163d51d786fbc01ac5d71e25efa7060"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_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="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_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 syslog_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 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>
- <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>SYSLOG_RELAY_E_SUCCESS on success, or an SYSLOG_RELAY_E_* error code otherwise. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a2543d1c8823b8202a089a6acbaa03845"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_relay_receive </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>size</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t * </td>
- <td class="paramname"><em>received</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Receives data from the service. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The syslog_relay client </td></tr>
- <tr><td class="paramname">data</td><td>Buffer that will be filled with the data received </td></tr>
- <tr><td class="paramname">size</td><td>Number of bytes to receive </td></tr>
- <tr><td class="paramname">received</td><td>Number of bytes received (can be NULL to ignore) </td></tr>
- <tr><td class="paramname">timeout</td><td>Maximum time in milliseconds to wait for data.</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="aced54910a322ae64952b9a8c9cb2f6b5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_relay_receive_with_timeout </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>size</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t * </td>
- <td class="paramname"><em>received</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned int </td>
- <td class="paramname"><em>timeout</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Receives data using the given syslog_relay client with specified timeout. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The syslog_relay client to use for receiving </td></tr>
- <tr><td class="paramname">data</td><td>Buffer that will be filled with the data received </td></tr>
- <tr><td class="paramname">size</td><td>Number of bytes to receive </td></tr>
- <tr><td class="paramname">received</td><td>Number of bytes received (can be NULL to ignore) </td></tr>
- <tr><td class="paramname">timeout</td><td>Maximum time in milliseconds to wait for data.</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="ad97df768574b94cc9fad0dd70db4702b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_relay_start_capture </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa2c4c793f1735c4165d263a9345ef1a2">syslog_relay_receive_cb_t</a> </td>
- <td class="paramname"><em>callback</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>user_data</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Starts capturing the syslog of the device using a callback. </p>
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The syslog_relay client to use </td></tr>
- <tr><td class="paramname">callback</td><td>Callback to receive each character from the syslog. </td></tr>
- <tr><td class="paramname">user_data</td><td>Custom pointer passed to the callback function.</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a0b231a01e41305227f90f40e9d74aeca"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="syslog__relay_8h.html#a9a712c417015ef1ccd29fa7e6d2e66e7">syslog_relay_error_t</a> syslog_relay_stop_capture </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="syslog__relay_8h.html#aa460066cb415ed01632f49ed32c0ba18">syslog_relay_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Stops capturing the syslog of the device. </p>
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The syslog_relay client to use</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </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>
|