debugserver_8h.html 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831
  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/debugserver.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">debugserver.h File Reference</div> </div>
  56. </div><!--header-->
  57. <div class="contents">
  58. <p>Communicate with debugserver on the 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:a1ba6ef5fd7ff7266e656df8bf1b7a34f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ba6ef5fd7ff7266e656df8bf1b7a34f"></a>
  64. #define&#160;</td><td class="memItemRight" valign="bottom"><b>DEBUGSERVER_SERVICE_NAME</b>&#160;&#160;&#160;&quot;com.apple.debugserver&quot;</td></tr>
  65. <tr class="separator:a1ba6ef5fd7ff7266e656df8bf1b7a34f"><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:ac836b99ee005b60c785ee983abf00f09"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac836b99ee005b60c785ee983abf00f09"></a>
  70. typedef struct <br class="typebreak" />
  71. debugserver_client_private&#160;</td><td class="memItemRight" valign="bottom"><b>debugserver_client_private</b></td></tr>
  72. <tr class="separator:ac836b99ee005b60c785ee983abf00f09"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a33fe91ded2130ae04bb52237d99fa25e"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
  74. debugserver_client_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a></td></tr>
  75. <tr class="memdesc:a33fe91ded2130ae04bb52237d99fa25e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle. <a href="#a33fe91ded2130ae04bb52237d99fa25e">More...</a><br /></td></tr>
  76. <tr class="separator:a33fe91ded2130ae04bb52237d99fa25e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a174176afcf6a46c01f2eb25277bef970"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a174176afcf6a46c01f2eb25277bef970"></a>
  78. typedef struct <br class="typebreak" />
  79. debugserver_command_private&#160;</td><td class="memItemRight" valign="bottom"><b>debugserver_command_private</b></td></tr>
  80. <tr class="separator:a174176afcf6a46c01f2eb25277bef970"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a97db39d020cf4f88b016a34af89f2cac"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
  82. debugserver_command_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a></td></tr>
  83. <tr class="memdesc:a97db39d020cf4f88b016a34af89f2cac"><td class="mdescLeft">&#160;</td><td class="mdescRight">The command handle. <a href="#a97db39d020cf4f88b016a34af89f2cac">More...</a><br /></td></tr>
  84. <tr class="separator:a97db39d020cf4f88b016a34af89f2cac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. </table><table class="memberdecls">
  86. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  87. Enumerations</h2></td></tr>
  88. <tr class="memitem:af64b81704b56df0ba59cdda83e00f01d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af64b81704b56df0ba59cdda83e00f01d"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> { <br />
  89. &#160;&#160;<b>DEBUGSERVER_E_SUCCESS</b> = 0,
  90. <br />
  91. &#160;&#160;<b>DEBUGSERVER_E_INVALID_ARG</b> = -1,
  92. <br />
  93. &#160;&#160;<b>DEBUGSERVER_E_MUX_ERROR</b> = -2,
  94. <br />
  95. &#160;&#160;<b>DEBUGSERVER_E_SSL_ERROR</b> = -3,
  96. <br />
  97. &#160;&#160;<b>DEBUGSERVER_E_RESPONSE_ERROR</b> = -4,
  98. <br />
  99. &#160;&#160;<b>DEBUGSERVER_E_UNKNOWN_ERROR</b> = -256
  100. <br />
  101. }</td></tr>
  102. <tr class="memdesc:af64b81704b56df0ba59cdda83e00f01d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error Codes. <br /></td></tr>
  103. <tr class="separator:af64b81704b56df0ba59cdda83e00f01d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table><table class="memberdecls">
  105. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  106. Functions</h2></td></tr>
  107. <tr class="memitem:af7558355a0dbc7319f3ee993ebfc8642"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#af7558355a0dbc7319f3ee993ebfc8642">debugserver_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> *client)</td></tr>
  108. <tr class="memdesc:af7558355a0dbc7319f3ee993ebfc8642"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the debugserver service on the specified device. <a href="#af7558355a0dbc7319f3ee993ebfc8642">More...</a><br /></td></tr>
  109. <tr class="separator:af7558355a0dbc7319f3ee993ebfc8642"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a85c626de0e4754d464be91315c715a05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a85c626de0e4754d464be91315c715a05">debugserver_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> *client, const char *label)</td></tr>
  111. <tr class="memdesc:a85c626de0e4754d464be91315c715a05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a new debugserver service on the specified device and connects to it. <a href="#a85c626de0e4754d464be91315c715a05">More...</a><br /></td></tr>
  112. <tr class="separator:a85c626de0e4754d464be91315c715a05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:ac69b57a167b826ad16669915cce992eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#ac69b57a167b826ad16669915cce992eb">debugserver_client_free</a> (<a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> client)</td></tr>
  114. <tr class="memdesc:ac69b57a167b826ad16669915cce992eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a debugserver client from the device and frees up the debugserver client data. <a href="#ac69b57a167b826ad16669915cce992eb">More...</a><br /></td></tr>
  115. <tr class="separator:ac69b57a167b826ad16669915cce992eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a607b788e29e96754c509d2a6468bfaae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a607b788e29e96754c509d2a6468bfaae">debugserver_client_send</a> (<a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> client, const char *data, uint32_t size, uint32_t *sent)</td></tr>
  117. <tr class="memdesc:a607b788e29e96754c509d2a6468bfaae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends raw data using the given debugserver service client. <a href="#a607b788e29e96754c509d2a6468bfaae">More...</a><br /></td></tr>
  118. <tr class="separator:a607b788e29e96754c509d2a6468bfaae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a68414df488f3c93a96dfd7602f8658c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a68414df488f3c93a96dfd7602f8658c0">debugserver_client_receive_with_timeout</a> (<a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> client, char *data, uint32_t size, uint32_t *received, unsigned int timeout)</td></tr>
  120. <tr class="memdesc:a68414df488f3c93a96dfd7602f8658c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives raw data using the given debugserver client with specified timeout. <a href="#a68414df488f3c93a96dfd7602f8658c0">More...</a><br /></td></tr>
  121. <tr class="separator:a68414df488f3c93a96dfd7602f8658c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a32dfa7616d0de019283dfa88abb64ea7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a32dfa7616d0de019283dfa88abb64ea7">debugserver_client_receive</a> (<a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> client, char *data, uint32_t size, uint32_t *received)</td></tr>
  123. <tr class="memdesc:a32dfa7616d0de019283dfa88abb64ea7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives raw data from the debugserver service. <a href="#a32dfa7616d0de019283dfa88abb64ea7">More...</a><br /></td></tr>
  124. <tr class="separator:a32dfa7616d0de019283dfa88abb64ea7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ae568e2af4fc08055e807e448327e4b82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#ae568e2af4fc08055e807e448327e4b82">debugserver_client_send_command</a> (<a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> client, <a class="el" href="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a> command, char **response)</td></tr>
  126. <tr class="memdesc:ae568e2af4fc08055e807e448327e4b82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a command to the debugserver service. <a href="#ae568e2af4fc08055e807e448327e4b82">More...</a><br /></td></tr>
  127. <tr class="separator:ae568e2af4fc08055e807e448327e4b82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:ae1eaa0c69f02b2179cf25a364ec96da5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#ae1eaa0c69f02b2179cf25a364ec96da5">debugserver_client_receive_response</a> (<a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> client, char **response)</td></tr>
  129. <tr class="memdesc:ae1eaa0c69f02b2179cf25a364ec96da5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives and parses response of debugserver service. <a href="#ae1eaa0c69f02b2179cf25a364ec96da5">More...</a><br /></td></tr>
  130. <tr class="separator:ae1eaa0c69f02b2179cf25a364ec96da5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a4720b533a7226958a34f508a79fa6cfb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a4720b533a7226958a34f508a79fa6cfb">debugserver_client_set_ack_mode</a> (<a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> client, int enabled)</td></tr>
  132. <tr class="memdesc:a4720b533a7226958a34f508a79fa6cfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Controls status of ACK mode when sending commands or receiving responses. <a href="#a4720b533a7226958a34f508a79fa6cfb">More...</a><br /></td></tr>
  133. <tr class="separator:a4720b533a7226958a34f508a79fa6cfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a85b0622f7df1c4ec01f9191d6af942d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a85b0622f7df1c4ec01f9191d6af942d7">debugserver_client_set_argv</a> (<a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> client, int argc, char *argv[], char **response)</td></tr>
  135. <tr class="memdesc:a85b0622f7df1c4ec01f9191d6af942d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the argv which launches an app. <a href="#a85b0622f7df1c4ec01f9191d6af942d7">More...</a><br /></td></tr>
  136. <tr class="separator:a85b0622f7df1c4ec01f9191d6af942d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a7e528914b87551dda608599142b2b3da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a7e528914b87551dda608599142b2b3da">debugserver_client_set_environment_hex_encoded</a> (<a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> client, const char *env, char **response)</td></tr>
  138. <tr class="memdesc:a7e528914b87551dda608599142b2b3da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds or sets an environment variable. <a href="#a7e528914b87551dda608599142b2b3da">More...</a><br /></td></tr>
  139. <tr class="separator:a7e528914b87551dda608599142b2b3da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a8e98630e39021c0605039fa43ef7b5f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a8e98630e39021c0605039fa43ef7b5f4">debugserver_command_new</a> (const char *name, int argc, char *argv[], <a class="el" href="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a> *command)</td></tr>
  141. <tr class="memdesc:a8e98630e39021c0605039fa43ef7b5f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and initializes a new command object. <a href="#a8e98630e39021c0605039fa43ef7b5f4">More...</a><br /></td></tr>
  142. <tr class="separator:a8e98630e39021c0605039fa43ef7b5f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a7ed23a2bcd8597fc2b66e2fee612ed45"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a7ed23a2bcd8597fc2b66e2fee612ed45">debugserver_command_free</a> (<a class="el" href="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a> command)</td></tr>
  144. <tr class="memdesc:a7ed23a2bcd8597fc2b66e2fee612ed45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees memory of command object. <a href="#a7ed23a2bcd8597fc2b66e2fee612ed45">More...</a><br /></td></tr>
  145. <tr class="separator:a7ed23a2bcd8597fc2b66e2fee612ed45"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a127587b6680773b4426980b8d30b3153"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a127587b6680773b4426980b8d30b3153">debugserver_encode_string</a> (const char *buffer, char **encoded_buffer, uint32_t *encoded_length)</td></tr>
  147. <tr class="memdesc:a127587b6680773b4426980b8d30b3153"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes a string into hex notation. <a href="#a127587b6680773b4426980b8d30b3153">More...</a><br /></td></tr>
  148. <tr class="separator:a127587b6680773b4426980b8d30b3153"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:af3997c3c08aadf190a5657cae7967f36"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#af3997c3c08aadf190a5657cae7967f36">debugserver_decode_string</a> (const char *encoded_buffer, size_t encoded_length, char **buffer)</td></tr>
  150. <tr class="memdesc:af3997c3c08aadf190a5657cae7967f36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decodes a hex encoded string. <a href="#af3997c3c08aadf190a5657cae7967f36">More...</a><br /></td></tr>
  151. <tr class="separator:af3997c3c08aadf190a5657cae7967f36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. </table>
  153. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  154. <div class="textblock"><p>Communicate with debugserver on the device. </p>
  155. </div><h2 class="groupheader">Typedef Documentation</h2>
  156. <a class="anchor" id="a33fe91ded2130ae04bb52237d99fa25e"></a>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname">typedef debugserver_client_private* <a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a></td>
  162. </tr>
  163. </table>
  164. </div><div class="memdoc">
  165. <p>The client handle. </p>
  166. </div>
  167. </div>
  168. <a class="anchor" id="a97db39d020cf4f88b016a34af89f2cac"></a>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">typedef debugserver_command_private* <a class="el" href="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a></td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>The command handle. </p>
  178. </div>
  179. </div>
  180. <h2 class="groupheader">Function Documentation</h2>
  181. <a class="anchor" id="ac69b57a167b826ad16669915cce992eb"></a>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_free </td>
  187. <td>(</td>
  188. <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a>&#160;</td>
  189. <td class="paramname"><em>client</em></td><td>)</td>
  190. <td></td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. <p>Disconnects a debugserver client from the device and frees up the debugserver client data. </p>
  195. <dl class="params"><dt>Parameters</dt><dd>
  196. <table class="params">
  197. <tr><td class="paramname">client</td><td>The debugserver client to disconnect and free.</td></tr>
  198. </table>
  199. </dd>
  200. </dl>
  201. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when client is NULL, or an DEBUGSERVER_E_* error code otherwise. </dd></dl>
  202. </div>
  203. </div>
  204. <a class="anchor" id="af7558355a0dbc7319f3ee993ebfc8642"></a>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_new </td>
  210. <td>(</td>
  211. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  212. <td class="paramname"><em>device</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype">lockdownd_service_descriptor_t&#160;</td>
  218. <td class="paramname"><em>service</em>, </td>
  219. </tr>
  220. <tr>
  221. <td class="paramkey"></td>
  222. <td></td>
  223. <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> *&#160;</td>
  224. <td class="paramname"><em>client</em>&#160;</td>
  225. </tr>
  226. <tr>
  227. <td></td>
  228. <td>)</td>
  229. <td></td><td></td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. <p>Connects to the debugserver service on the specified device. </p>
  234. <dl class="params"><dt>Parameters</dt><dd>
  235. <table class="params">
  236. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  237. <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
  238. <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated debugserver_client_t upon successful return. Must be freed using <a class="el" href="debugserver_8h.html#ac69b57a167b826ad16669915cce992eb" title="Disconnects a debugserver client from the device and frees up the debugserver client data...">debugserver_client_free()</a> after use.</td></tr>
  239. </table>
  240. </dd>
  241. </dl>
  242. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when client is NULL, or an DEBUGSERVER_E_* error code otherwise. </dd></dl>
  243. </div>
  244. </div>
  245. <a class="anchor" id="a32dfa7616d0de019283dfa88abb64ea7"></a>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_receive </td>
  251. <td>(</td>
  252. <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a>&#160;</td>
  253. <td class="paramname"><em>client</em>, </td>
  254. </tr>
  255. <tr>
  256. <td class="paramkey"></td>
  257. <td></td>
  258. <td class="paramtype">char *&#160;</td>
  259. <td class="paramname"><em>data</em>, </td>
  260. </tr>
  261. <tr>
  262. <td class="paramkey"></td>
  263. <td></td>
  264. <td class="paramtype">uint32_t&#160;</td>
  265. <td class="paramname"><em>size</em>, </td>
  266. </tr>
  267. <tr>
  268. <td class="paramkey"></td>
  269. <td></td>
  270. <td class="paramtype">uint32_t *&#160;</td>
  271. <td class="paramname"><em>received</em>&#160;</td>
  272. </tr>
  273. <tr>
  274. <td></td>
  275. <td>)</td>
  276. <td></td><td></td>
  277. </tr>
  278. </table>
  279. </div><div class="memdoc">
  280. <p>Receives raw data from the debugserver service. </p>
  281. <dl class="params"><dt>Parameters</dt><dd>
  282. <table class="params">
  283. <tr><td class="paramname">client</td><td>The debugserver client </td></tr>
  284. <tr><td class="paramname">data</td><td>Buffer that will be filled with the data received </td></tr>
  285. <tr><td class="paramname">size</td><td>Number of bytes to receive </td></tr>
  286. <tr><td class="paramname">received</td><td>Number of bytes received (can be NULL to ignore) </td></tr>
  287. </table>
  288. </dd>
  289. </dl>
  290. <dl class="section note"><dt>Note</dt><dd>The default read timeout is 10 seconds.</dd></dl>
  291. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when client or plist is NULL </dd></dl>
  292. </div>
  293. </div>
  294. <a class="anchor" id="ae1eaa0c69f02b2179cf25a364ec96da5"></a>
  295. <div class="memitem">
  296. <div class="memproto">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_receive_response </td>
  300. <td>(</td>
  301. <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a>&#160;</td>
  302. <td class="paramname"><em>client</em>, </td>
  303. </tr>
  304. <tr>
  305. <td class="paramkey"></td>
  306. <td></td>
  307. <td class="paramtype">char **&#160;</td>
  308. <td class="paramname"><em>response</em>&#160;</td>
  309. </tr>
  310. <tr>
  311. <td></td>
  312. <td>)</td>
  313. <td></td><td></td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. <p>Receives and parses response of debugserver service. </p>
  318. <dl class="params"><dt>Parameters</dt><dd>
  319. <table class="params">
  320. <tr><td class="paramname">client</td><td>The debugserver client </td></tr>
  321. <tr><td class="paramname">response</td><td>Response received for last command (can be NULL to ignore)</td></tr>
  322. </table>
  323. </dd>
  324. </dl>
  325. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when client is NULL </dd></dl>
  326. </div>
  327. </div>
  328. <a class="anchor" id="a68414df488f3c93a96dfd7602f8658c0"></a>
  329. <div class="memitem">
  330. <div class="memproto">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_receive_with_timeout </td>
  334. <td>(</td>
  335. <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a>&#160;</td>
  336. <td class="paramname"><em>client</em>, </td>
  337. </tr>
  338. <tr>
  339. <td class="paramkey"></td>
  340. <td></td>
  341. <td class="paramtype">char *&#160;</td>
  342. <td class="paramname"><em>data</em>, </td>
  343. </tr>
  344. <tr>
  345. <td class="paramkey"></td>
  346. <td></td>
  347. <td class="paramtype">uint32_t&#160;</td>
  348. <td class="paramname"><em>size</em>, </td>
  349. </tr>
  350. <tr>
  351. <td class="paramkey"></td>
  352. <td></td>
  353. <td class="paramtype">uint32_t *&#160;</td>
  354. <td class="paramname"><em>received</em>, </td>
  355. </tr>
  356. <tr>
  357. <td class="paramkey"></td>
  358. <td></td>
  359. <td class="paramtype">unsigned int&#160;</td>
  360. <td class="paramname"><em>timeout</em>&#160;</td>
  361. </tr>
  362. <tr>
  363. <td></td>
  364. <td>)</td>
  365. <td></td><td></td>
  366. </tr>
  367. </table>
  368. </div><div class="memdoc">
  369. <p>Receives raw data using the given debugserver client with specified timeout. </p>
  370. <dl class="params"><dt>Parameters</dt><dd>
  371. <table class="params">
  372. <tr><td class="paramname">client</td><td>The debugserver client to use for receiving </td></tr>
  373. <tr><td class="paramname">data</td><td>Buffer that will be filled with the data received </td></tr>
  374. <tr><td class="paramname">size</td><td>Number of bytes to receive </td></tr>
  375. <tr><td class="paramname">received</td><td>Number of bytes received (can be NULL to ignore) </td></tr>
  376. <tr><td class="paramname">timeout</td><td>Maximum time in milliseconds to wait for data.</td></tr>
  377. </table>
  378. </dd>
  379. </dl>
  380. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when one or more parameters are invalid, DEBUGSERVER_E_MUX_ERROR when a communication error occurs, or DEBUGSERVER_E_UNKNOWN_ERROR when an unspecified error occurs. </dd></dl>
  381. </div>
  382. </div>
  383. <a class="anchor" id="a607b788e29e96754c509d2a6468bfaae"></a>
  384. <div class="memitem">
  385. <div class="memproto">
  386. <table class="memname">
  387. <tr>
  388. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_send </td>
  389. <td>(</td>
  390. <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a>&#160;</td>
  391. <td class="paramname"><em>client</em>, </td>
  392. </tr>
  393. <tr>
  394. <td class="paramkey"></td>
  395. <td></td>
  396. <td class="paramtype">const char *&#160;</td>
  397. <td class="paramname"><em>data</em>, </td>
  398. </tr>
  399. <tr>
  400. <td class="paramkey"></td>
  401. <td></td>
  402. <td class="paramtype">uint32_t&#160;</td>
  403. <td class="paramname"><em>size</em>, </td>
  404. </tr>
  405. <tr>
  406. <td class="paramkey"></td>
  407. <td></td>
  408. <td class="paramtype">uint32_t *&#160;</td>
  409. <td class="paramname"><em>sent</em>&#160;</td>
  410. </tr>
  411. <tr>
  412. <td></td>
  413. <td>)</td>
  414. <td></td><td></td>
  415. </tr>
  416. </table>
  417. </div><div class="memdoc">
  418. <p>Sends raw data using the given debugserver service client. </p>
  419. <dl class="params"><dt>Parameters</dt><dd>
  420. <table class="params">
  421. <tr><td class="paramname">client</td><td>The debugserver client to use for sending </td></tr>
  422. <tr><td class="paramname">data</td><td>Data to send </td></tr>
  423. <tr><td class="paramname">size</td><td>Size of the data to send </td></tr>
  424. <tr><td class="paramname">sent</td><td>Number of bytes sent (can be NULL to ignore)</td></tr>
  425. </table>
  426. </dd>
  427. </dl>
  428. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when one or more parameters are invalid, or DEBUGSERVER_E_UNKNOWN_ERROR when an unspecified error occurs. </dd></dl>
  429. </div>
  430. </div>
  431. <a class="anchor" id="ae568e2af4fc08055e807e448327e4b82"></a>
  432. <div class="memitem">
  433. <div class="memproto">
  434. <table class="memname">
  435. <tr>
  436. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_send_command </td>
  437. <td>(</td>
  438. <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a>&#160;</td>
  439. <td class="paramname"><em>client</em>, </td>
  440. </tr>
  441. <tr>
  442. <td class="paramkey"></td>
  443. <td></td>
  444. <td class="paramtype"><a class="el" href="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a>&#160;</td>
  445. <td class="paramname"><em>command</em>, </td>
  446. </tr>
  447. <tr>
  448. <td class="paramkey"></td>
  449. <td></td>
  450. <td class="paramtype">char **&#160;</td>
  451. <td class="paramname"><em>response</em>&#160;</td>
  452. </tr>
  453. <tr>
  454. <td></td>
  455. <td>)</td>
  456. <td></td><td></td>
  457. </tr>
  458. </table>
  459. </div><div class="memdoc">
  460. <p>Sends a command to the debugserver service. </p>
  461. <dl class="params"><dt>Parameters</dt><dd>
  462. <table class="params">
  463. <tr><td class="paramname">client</td><td>The debugserver client </td></tr>
  464. <tr><td class="paramname">command</td><td>Command to process and send </td></tr>
  465. <tr><td class="paramname">response</td><td>Response received for the command (can be NULL to ignore)</td></tr>
  466. </table>
  467. </dd>
  468. </dl>
  469. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when client or command is NULL </dd></dl>
  470. </div>
  471. </div>
  472. <a class="anchor" id="a4720b533a7226958a34f508a79fa6cfb"></a>
  473. <div class="memitem">
  474. <div class="memproto">
  475. <table class="memname">
  476. <tr>
  477. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_set_ack_mode </td>
  478. <td>(</td>
  479. <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a>&#160;</td>
  480. <td class="paramname"><em>client</em>, </td>
  481. </tr>
  482. <tr>
  483. <td class="paramkey"></td>
  484. <td></td>
  485. <td class="paramtype">int&#160;</td>
  486. <td class="paramname"><em>enabled</em>&#160;</td>
  487. </tr>
  488. <tr>
  489. <td></td>
  490. <td>)</td>
  491. <td></td><td></td>
  492. </tr>
  493. </table>
  494. </div><div class="memdoc">
  495. <p>Controls status of ACK mode when sending commands or receiving responses. </p>
  496. <dl class="section see"><dt>See also</dt><dd><a class="el" href="debugserver_8h.html#ae568e2af4fc08055e807e448327e4b82" title="Sends a command to the debugserver service. ">debugserver_client_send_command</a>, <a class="el" href="debugserver_8h.html#ae1eaa0c69f02b2179cf25a364ec96da5" title="Receives and parses response of debugserver service. ">debugserver_client_receive_response</a></dd></dl>
  497. <dl class="params"><dt>Parameters</dt><dd>
  498. <table class="params">
  499. <tr><td class="paramname">client</td><td>The debugserver client </td></tr>
  500. <tr><td class="paramname">enabled</td><td>A boolean flag indicating whether the internal ACK mode handling should be enabled or disabled.</td></tr>
  501. </table>
  502. </dd>
  503. </dl>
  504. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error code otherwise. </dd></dl>
  505. </div>
  506. </div>
  507. <a class="anchor" id="a85b0622f7df1c4ec01f9191d6af942d7"></a>
  508. <div class="memitem">
  509. <div class="memproto">
  510. <table class="memname">
  511. <tr>
  512. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_set_argv </td>
  513. <td>(</td>
  514. <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a>&#160;</td>
  515. <td class="paramname"><em>client</em>, </td>
  516. </tr>
  517. <tr>
  518. <td class="paramkey"></td>
  519. <td></td>
  520. <td class="paramtype">int&#160;</td>
  521. <td class="paramname"><em>argc</em>, </td>
  522. </tr>
  523. <tr>
  524. <td class="paramkey"></td>
  525. <td></td>
  526. <td class="paramtype">char *&#160;</td>
  527. <td class="paramname"><em>argv</em>[], </td>
  528. </tr>
  529. <tr>
  530. <td class="paramkey"></td>
  531. <td></td>
  532. <td class="paramtype">char **&#160;</td>
  533. <td class="paramname"><em>response</em>&#160;</td>
  534. </tr>
  535. <tr>
  536. <td></td>
  537. <td>)</td>
  538. <td></td><td></td>
  539. </tr>
  540. </table>
  541. </div><div class="memdoc">
  542. <p>Sets the argv which launches an app. </p>
  543. <dl class="params"><dt>Parameters</dt><dd>
  544. <table class="params">
  545. <tr><td class="paramname">client</td><td>The debugserver client </td></tr>
  546. <tr><td class="paramname">argc</td><td>Number of arguments </td></tr>
  547. <tr><td class="paramname">argv</td><td>Array starting with the executable to be run followed by it's arguments </td></tr>
  548. <tr><td class="paramname">response</td><td>Response received for the command (can be NULL to ignore)</td></tr>
  549. </table>
  550. </dd>
  551. </dl>
  552. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when client is NULL </dd></dl>
  553. </div>
  554. </div>
  555. <a class="anchor" id="a7e528914b87551dda608599142b2b3da"></a>
  556. <div class="memitem">
  557. <div class="memproto">
  558. <table class="memname">
  559. <tr>
  560. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_set_environment_hex_encoded </td>
  561. <td>(</td>
  562. <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a>&#160;</td>
  563. <td class="paramname"><em>client</em>, </td>
  564. </tr>
  565. <tr>
  566. <td class="paramkey"></td>
  567. <td></td>
  568. <td class="paramtype">const char *&#160;</td>
  569. <td class="paramname"><em>env</em>, </td>
  570. </tr>
  571. <tr>
  572. <td class="paramkey"></td>
  573. <td></td>
  574. <td class="paramtype">char **&#160;</td>
  575. <td class="paramname"><em>response</em>&#160;</td>
  576. </tr>
  577. <tr>
  578. <td></td>
  579. <td>)</td>
  580. <td></td><td></td>
  581. </tr>
  582. </table>
  583. </div><div class="memdoc">
  584. <p>Adds or sets an environment variable. </p>
  585. <dl class="params"><dt>Parameters</dt><dd>
  586. <table class="params">
  587. <tr><td class="paramname">client</td><td>The debugserver client </td></tr>
  588. <tr><td class="paramname">env</td><td>The environment variable in "KEY=VALUE" notation </td></tr>
  589. <tr><td class="paramname">response</td><td>Response received for the command (can be NULL to ignore)</td></tr>
  590. </table>
  591. </dd>
  592. </dl>
  593. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when client is NULL </dd></dl>
  594. </div>
  595. </div>
  596. <a class="anchor" id="a85c626de0e4754d464be91315c715a05"></a>
  597. <div class="memitem">
  598. <div class="memproto">
  599. <table class="memname">
  600. <tr>
  601. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_start_service </td>
  602. <td>(</td>
  603. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  604. <td class="paramname"><em>device</em>, </td>
  605. </tr>
  606. <tr>
  607. <td class="paramkey"></td>
  608. <td></td>
  609. <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> *&#160;</td>
  610. <td class="paramname"><em>client</em>, </td>
  611. </tr>
  612. <tr>
  613. <td class="paramkey"></td>
  614. <td></td>
  615. <td class="paramtype">const char *&#160;</td>
  616. <td class="paramname"><em>label</em>&#160;</td>
  617. </tr>
  618. <tr>
  619. <td></td>
  620. <td>)</td>
  621. <td></td><td></td>
  622. </tr>
  623. </table>
  624. </div><div class="memdoc">
  625. <p>Starts a new debugserver service on the specified device and connects to it. </p>
  626. <dl class="params"><dt>Parameters</dt><dd>
  627. <table class="params">
  628. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  629. <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated debugserver_client_t upon successful return. Must be freed using <a class="el" href="debugserver_8h.html#ac69b57a167b826ad16669915cce992eb" title="Disconnects a debugserver client from the device and frees up the debugserver client data...">debugserver_client_free()</a> after use. </td></tr>
  630. <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>
  631. </table>
  632. </dd>
  633. </dl>
  634. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error code otherwise. </dd></dl>
  635. </div>
  636. </div>
  637. <a class="anchor" id="a7ed23a2bcd8597fc2b66e2fee612ed45"></a>
  638. <div class="memitem">
  639. <div class="memproto">
  640. <table class="memname">
  641. <tr>
  642. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_command_free </td>
  643. <td>(</td>
  644. <td class="paramtype"><a class="el" href="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a>&#160;</td>
  645. <td class="paramname"><em>command</em></td><td>)</td>
  646. <td></td>
  647. </tr>
  648. </table>
  649. </div><div class="memdoc">
  650. <p>Frees memory of command object. </p>
  651. <dl class="params"><dt>Parameters</dt><dd>
  652. <table class="params">
  653. <tr><td class="paramname">command</td><td>The command object</td></tr>
  654. </table>
  655. </dd>
  656. </dl>
  657. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when command is NULL </dd></dl>
  658. </div>
  659. </div>
  660. <a class="anchor" id="a8e98630e39021c0605039fa43ef7b5f4"></a>
  661. <div class="memitem">
  662. <div class="memproto">
  663. <table class="memname">
  664. <tr>
  665. <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_command_new </td>
  666. <td>(</td>
  667. <td class="paramtype">const char *&#160;</td>
  668. <td class="paramname"><em>name</em>, </td>
  669. </tr>
  670. <tr>
  671. <td class="paramkey"></td>
  672. <td></td>
  673. <td class="paramtype">int&#160;</td>
  674. <td class="paramname"><em>argc</em>, </td>
  675. </tr>
  676. <tr>
  677. <td class="paramkey"></td>
  678. <td></td>
  679. <td class="paramtype">char *&#160;</td>
  680. <td class="paramname"><em>argv</em>[], </td>
  681. </tr>
  682. <tr>
  683. <td class="paramkey"></td>
  684. <td></td>
  685. <td class="paramtype"><a class="el" href="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a> *&#160;</td>
  686. <td class="paramname"><em>command</em>&#160;</td>
  687. </tr>
  688. <tr>
  689. <td></td>
  690. <td>)</td>
  691. <td></td><td></td>
  692. </tr>
  693. </table>
  694. </div><div class="memdoc">
  695. <p>Creates and initializes a new command object. </p>
  696. <dl class="params"><dt>Parameters</dt><dd>
  697. <table class="params">
  698. <tr><td class="paramname">name</td><td>The name of the command which is sent in plain text </td></tr>
  699. <tr><td class="paramname">argv</td><td>Array of tokens for the command ment to be encoded </td></tr>
  700. <tr><td class="paramname">argc</td><td>Number of items in the token array </td></tr>
  701. <tr><td class="paramname">command</td><td>New command object</td></tr>
  702. </table>
  703. </dd>
  704. </dl>
  705. <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when name or command is NULL </dd></dl>
  706. </div>
  707. </div>
  708. <a class="anchor" id="af3997c3c08aadf190a5657cae7967f36"></a>
  709. <div class="memitem">
  710. <div class="memproto">
  711. <table class="memname">
  712. <tr>
  713. <td class="memname">void debugserver_decode_string </td>
  714. <td>(</td>
  715. <td class="paramtype">const char *&#160;</td>
  716. <td class="paramname"><em>encoded_buffer</em>, </td>
  717. </tr>
  718. <tr>
  719. <td class="paramkey"></td>
  720. <td></td>
  721. <td class="paramtype">size_t&#160;</td>
  722. <td class="paramname"><em>encoded_length</em>, </td>
  723. </tr>
  724. <tr>
  725. <td class="paramkey"></td>
  726. <td></td>
  727. <td class="paramtype">char **&#160;</td>
  728. <td class="paramname"><em>buffer</em>&#160;</td>
  729. </tr>
  730. <tr>
  731. <td></td>
  732. <td>)</td>
  733. <td></td><td></td>
  734. </tr>
  735. </table>
  736. </div><div class="memdoc">
  737. <p>Decodes a hex encoded string. </p>
  738. <dl class="params"><dt>Parameters</dt><dd>
  739. <table class="params">
  740. <tr><td class="paramname">encoded_buffer</td><td>The buffer with a hex encoded string </td></tr>
  741. <tr><td class="paramname">encoded_length</td><td>Length of the encoded buffer </td></tr>
  742. <tr><td class="paramname">buffer</td><td>Decoded string to be freed by the caller </td></tr>
  743. </table>
  744. </dd>
  745. </dl>
  746. </div>
  747. </div>
  748. <a class="anchor" id="a127587b6680773b4426980b8d30b3153"></a>
  749. <div class="memitem">
  750. <div class="memproto">
  751. <table class="memname">
  752. <tr>
  753. <td class="memname">void debugserver_encode_string </td>
  754. <td>(</td>
  755. <td class="paramtype">const char *&#160;</td>
  756. <td class="paramname"><em>buffer</em>, </td>
  757. </tr>
  758. <tr>
  759. <td class="paramkey"></td>
  760. <td></td>
  761. <td class="paramtype">char **&#160;</td>
  762. <td class="paramname"><em>encoded_buffer</em>, </td>
  763. </tr>
  764. <tr>
  765. <td class="paramkey"></td>
  766. <td></td>
  767. <td class="paramtype">uint32_t *&#160;</td>
  768. <td class="paramname"><em>encoded_length</em>&#160;</td>
  769. </tr>
  770. <tr>
  771. <td></td>
  772. <td>)</td>
  773. <td></td><td></td>
  774. </tr>
  775. </table>
  776. </div><div class="memdoc">
  777. <p>Encodes a string into hex notation. </p>
  778. <dl class="params"><dt>Parameters</dt><dd>
  779. <table class="params">
  780. <tr><td class="paramname">buffer</td><td>String to encode into hex notiation </td></tr>
  781. <tr><td class="paramname">encoded_buffer</td><td>The buffer receives a hex encoded string </td></tr>
  782. <tr><td class="paramname">encoded_length</td><td>Length of the hex encoded string </td></tr>
  783. </table>
  784. </dd>
  785. </dl>
  786. </div>
  787. </div>
  788. </div><!-- contents -->
  789. <!-- start footer part -->
  790. <hr class="footer"/><address class="footer"><small>
  791. Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by &#160;<a href="http://www.doxygen.org/index.html">
  792. <img class="footer" src="doxygen.png" alt="doxygen"/>
  793. </a> 1.8.8
  794. </small></address>
  795. </body>
  796. </html>