| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831 |
- <!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/debugserver.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">debugserver.h File Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Communicate with debugserver on the 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:a1ba6ef5fd7ff7266e656df8bf1b7a34f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ba6ef5fd7ff7266e656df8bf1b7a34f"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>DEBUGSERVER_SERVICE_NAME</b>   "com.apple.debugserver"</td></tr>
- <tr class="separator:a1ba6ef5fd7ff7266e656df8bf1b7a34f"><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:ac836b99ee005b60c785ee983abf00f09"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac836b99ee005b60c785ee983abf00f09"></a>
- typedef struct <br class="typebreak" />
- debugserver_client_private </td><td class="memItemRight" valign="bottom"><b>debugserver_client_private</b></td></tr>
- <tr class="separator:ac836b99ee005b60c785ee983abf00f09"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a33fe91ded2130ae04bb52237d99fa25e"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
- debugserver_client_private * </td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a></td></tr>
- <tr class="memdesc:a33fe91ded2130ae04bb52237d99fa25e"><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#a33fe91ded2130ae04bb52237d99fa25e">More...</a><br /></td></tr>
- <tr class="separator:a33fe91ded2130ae04bb52237d99fa25e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a174176afcf6a46c01f2eb25277bef970"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a174176afcf6a46c01f2eb25277bef970"></a>
- typedef struct <br class="typebreak" />
- debugserver_command_private </td><td class="memItemRight" valign="bottom"><b>debugserver_command_private</b></td></tr>
- <tr class="separator:a174176afcf6a46c01f2eb25277bef970"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a97db39d020cf4f88b016a34af89f2cac"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
- debugserver_command_private * </td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a></td></tr>
- <tr class="memdesc:a97db39d020cf4f88b016a34af89f2cac"><td class="mdescLeft"> </td><td class="mdescRight">The command handle. <a href="#a97db39d020cf4f88b016a34af89f2cac">More...</a><br /></td></tr>
- <tr class="separator:a97db39d020cf4f88b016a34af89f2cac"><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:af64b81704b56df0ba59cdda83e00f01d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af64b81704b56df0ba59cdda83e00f01d"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> { <br />
-   <b>DEBUGSERVER_E_SUCCESS</b> = 0,
- <br />
-   <b>DEBUGSERVER_E_INVALID_ARG</b> = -1,
- <br />
-   <b>DEBUGSERVER_E_MUX_ERROR</b> = -2,
- <br />
-   <b>DEBUGSERVER_E_SSL_ERROR</b> = -3,
- <br />
-   <b>DEBUGSERVER_E_RESPONSE_ERROR</b> = -4,
- <br />
-   <b>DEBUGSERVER_E_UNKNOWN_ERROR</b> = -256
- <br />
- }</td></tr>
- <tr class="memdesc:af64b81704b56df0ba59cdda83e00f01d"><td class="mdescLeft"> </td><td class="mdescRight">Error Codes. <br /></td></tr>
- <tr class="separator:af64b81704b56df0ba59cdda83e00f01d"><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:af7558355a0dbc7319f3ee993ebfc8642"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:af7558355a0dbc7319f3ee993ebfc8642"><td class="mdescLeft"> </td><td class="mdescRight">Connects to the debugserver service on the specified device. <a href="#af7558355a0dbc7319f3ee993ebfc8642">More...</a><br /></td></tr>
- <tr class="separator:af7558355a0dbc7319f3ee993ebfc8642"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a85c626de0e4754d464be91315c715a05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:a85c626de0e4754d464be91315c715a05"><td class="mdescLeft"> </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>
- <tr class="separator:a85c626de0e4754d464be91315c715a05"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac69b57a167b826ad16669915cce992eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:ac69b57a167b826ad16669915cce992eb"><td class="mdescLeft"> </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>
- <tr class="separator:ac69b57a167b826ad16669915cce992eb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a607b788e29e96754c509d2a6468bfaae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:a607b788e29e96754c509d2a6468bfaae"><td class="mdescLeft"> </td><td class="mdescRight">Sends raw data using the given debugserver service client. <a href="#a607b788e29e96754c509d2a6468bfaae">More...</a><br /></td></tr>
- <tr class="separator:a607b788e29e96754c509d2a6468bfaae"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a68414df488f3c93a96dfd7602f8658c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:a68414df488f3c93a96dfd7602f8658c0"><td class="mdescLeft"> </td><td class="mdescRight">Receives raw data using the given debugserver client with specified timeout. <a href="#a68414df488f3c93a96dfd7602f8658c0">More...</a><br /></td></tr>
- <tr class="separator:a68414df488f3c93a96dfd7602f8658c0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a32dfa7616d0de019283dfa88abb64ea7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:a32dfa7616d0de019283dfa88abb64ea7"><td class="mdescLeft"> </td><td class="mdescRight">Receives raw data from the debugserver service. <a href="#a32dfa7616d0de019283dfa88abb64ea7">More...</a><br /></td></tr>
- <tr class="separator:a32dfa7616d0de019283dfa88abb64ea7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae568e2af4fc08055e807e448327e4b82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:ae568e2af4fc08055e807e448327e4b82"><td class="mdescLeft"> </td><td class="mdescRight">Sends a command to the debugserver service. <a href="#ae568e2af4fc08055e807e448327e4b82">More...</a><br /></td></tr>
- <tr class="separator:ae568e2af4fc08055e807e448327e4b82"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae1eaa0c69f02b2179cf25a364ec96da5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:ae1eaa0c69f02b2179cf25a364ec96da5"><td class="mdescLeft"> </td><td class="mdescRight">Receives and parses response of debugserver service. <a href="#ae1eaa0c69f02b2179cf25a364ec96da5">More...</a><br /></td></tr>
- <tr class="separator:ae1eaa0c69f02b2179cf25a364ec96da5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4720b533a7226958a34f508a79fa6cfb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:a4720b533a7226958a34f508a79fa6cfb"><td class="mdescLeft"> </td><td class="mdescRight">Controls status of ACK mode when sending commands or receiving responses. <a href="#a4720b533a7226958a34f508a79fa6cfb">More...</a><br /></td></tr>
- <tr class="separator:a4720b533a7226958a34f508a79fa6cfb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a85b0622f7df1c4ec01f9191d6af942d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:a85b0622f7df1c4ec01f9191d6af942d7"><td class="mdescLeft"> </td><td class="mdescRight">Sets the argv which launches an app. <a href="#a85b0622f7df1c4ec01f9191d6af942d7">More...</a><br /></td></tr>
- <tr class="separator:a85b0622f7df1c4ec01f9191d6af942d7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7e528914b87551dda608599142b2b3da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:a7e528914b87551dda608599142b2b3da"><td class="mdescLeft"> </td><td class="mdescRight">Adds or sets an environment variable. <a href="#a7e528914b87551dda608599142b2b3da">More...</a><br /></td></tr>
- <tr class="separator:a7e528914b87551dda608599142b2b3da"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8e98630e39021c0605039fa43ef7b5f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:a8e98630e39021c0605039fa43ef7b5f4"><td class="mdescLeft"> </td><td class="mdescRight">Creates and initializes a new command object. <a href="#a8e98630e39021c0605039fa43ef7b5f4">More...</a><br /></td></tr>
- <tr class="separator:a8e98630e39021c0605039fa43ef7b5f4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7ed23a2bcd8597fc2b66e2fee612ed45"><td class="memItemLeft" align="right" valign="top"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> </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>
- <tr class="memdesc:a7ed23a2bcd8597fc2b66e2fee612ed45"><td class="mdescLeft"> </td><td class="mdescRight">Frees memory of command object. <a href="#a7ed23a2bcd8597fc2b66e2fee612ed45">More...</a><br /></td></tr>
- <tr class="separator:a7ed23a2bcd8597fc2b66e2fee612ed45"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a127587b6680773b4426980b8d30b3153"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="memdesc:a127587b6680773b4426980b8d30b3153"><td class="mdescLeft"> </td><td class="mdescRight">Encodes a string into hex notation. <a href="#a127587b6680773b4426980b8d30b3153">More...</a><br /></td></tr>
- <tr class="separator:a127587b6680773b4426980b8d30b3153"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af3997c3c08aadf190a5657cae7967f36"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="memdesc:af3997c3c08aadf190a5657cae7967f36"><td class="mdescLeft"> </td><td class="mdescRight">Decodes a hex encoded string. <a href="#af3997c3c08aadf190a5657cae7967f36">More...</a><br /></td></tr>
- <tr class="separator:af3997c3c08aadf190a5657cae7967f36"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Communicate with debugserver on the device. </p>
- </div><h2 class="groupheader">Typedef Documentation</h2>
- <a class="anchor" id="a33fe91ded2130ae04bb52237d99fa25e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef debugserver_client_private* <a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The client handle. </p>
- </div>
- </div>
- <a class="anchor" id="a97db39d020cf4f88b016a34af89f2cac"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef debugserver_command_private* <a class="el" href="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The command handle. </p>
- </div>
- </div>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="ac69b57a167b826ad16669915cce992eb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_free </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Disconnects a debugserver client from the device and frees up the debugserver client data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The debugserver client to disconnect and free.</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="af7558355a0dbc7319f3ee993ebfc8642"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_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="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_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 debugserver 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 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>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a32dfa7616d0de019283dfa88abb64ea7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_receive </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_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 raw data from the debugserver service. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The debugserver 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>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>The default read timeout is 10 seconds.</dd></dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="ae1eaa0c69f02b2179cf25a364ec96da5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_receive_response </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_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>response</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Receives and parses response of debugserver service. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The debugserver client </td></tr>
- <tr><td class="paramname">response</td><td>Response received for last command (can be NULL to ignore)</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when client is NULL </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a68414df488f3c93a96dfd7602f8658c0"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_receive_with_timeout </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_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 raw data using the given debugserver client with specified timeout. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The debugserver 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>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>
- </div>
- </div>
- <a class="anchor" id="a607b788e29e96754c509d2a6468bfaae"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_send </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_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>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>sent</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends raw data using the given debugserver service client. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The debugserver client to use for sending </td></tr>
- <tr><td class="paramname">data</td><td>Data to send </td></tr>
- <tr><td class="paramname">size</td><td>Size of the data to send </td></tr>
- <tr><td class="paramname">sent</td><td>Number of bytes sent (can be NULL to ignore)</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="ae568e2af4fc08055e807e448327e4b82"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_send_command </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_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="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a> </td>
- <td class="paramname"><em>command</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char ** </td>
- <td class="paramname"><em>response</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends a command to the debugserver service. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The debugserver client </td></tr>
- <tr><td class="paramname">command</td><td>Command to process and send </td></tr>
- <tr><td class="paramname">response</td><td>Response received for the command (can be NULL to ignore)</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a4720b533a7226958a34f508a79fa6cfb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_set_ack_mode </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>enabled</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Controls status of ACK mode when sending commands or receiving responses. </p>
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The debugserver client </td></tr>
- <tr><td class="paramname">enabled</td><td>A boolean flag indicating whether the internal ACK mode handling should be enabled or disabled.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error code otherwise. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a85b0622f7df1c4ec01f9191d6af942d7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_set_argv </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>argc</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char * </td>
- <td class="paramname"><em>argv</em>[], </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char ** </td>
- <td class="paramname"><em>response</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the argv which launches an app. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The debugserver client </td></tr>
- <tr><td class="paramname">argc</td><td>Number of arguments </td></tr>
- <tr><td class="paramname">argv</td><td>Array starting with the executable to be run followed by it's arguments </td></tr>
- <tr><td class="paramname">response</td><td>Response received for the command (can be NULL to ignore)</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when client is NULL </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a7e528914b87551dda608599142b2b3da"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_client_set_environment_hex_encoded </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_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>env</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char ** </td>
- <td class="paramname"><em>response</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Adds or sets an environment variable. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The debugserver client </td></tr>
- <tr><td class="paramname">env</td><td>The environment variable in "KEY=VALUE" notation </td></tr>
- <tr><td class="paramname">response</td><td>Response received for the command (can be NULL to ignore)</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when client is NULL </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a85c626de0e4754d464be91315c715a05"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_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="debugserver_8h.html#a33fe91ded2130ae04bb52237d99fa25e">debugserver_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 debugserver 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 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>
- <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>DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error code otherwise. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a7ed23a2bcd8597fc2b66e2fee612ed45"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_command_free </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a> </td>
- <td class="paramname"><em>command</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Frees memory of command object. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">command</td><td>The command object</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when command is NULL </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a8e98630e39021c0605039fa43ef7b5f4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="debugserver_8h.html#af64b81704b56df0ba59cdda83e00f01d">debugserver_error_t</a> debugserver_command_new </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>name</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>argc</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char * </td>
- <td class="paramname"><em>argv</em>[], </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="debugserver_8h.html#a97db39d020cf4f88b016a34af89f2cac">debugserver_command_t</a> * </td>
- <td class="paramname"><em>command</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Creates and initializes a new command object. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">name</td><td>The name of the command which is sent in plain text </td></tr>
- <tr><td class="paramname">argv</td><td>Array of tokens for the command ment to be encoded </td></tr>
- <tr><td class="paramname">argc</td><td>Number of items in the token array </td></tr>
- <tr><td class="paramname">command</td><td>New command object</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="af3997c3c08aadf190a5657cae7967f36"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void debugserver_decode_string </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>encoded_buffer</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size_t </td>
- <td class="paramname"><em>encoded_length</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char ** </td>
- <td class="paramname"><em>buffer</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Decodes a hex encoded string. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">encoded_buffer</td><td>The buffer with a hex encoded string </td></tr>
- <tr><td class="paramname">encoded_length</td><td>Length of the encoded buffer </td></tr>
- <tr><td class="paramname">buffer</td><td>Decoded string to be freed by the caller </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a127587b6680773b4426980b8d30b3153"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void debugserver_encode_string </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>buffer</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char ** </td>
- <td class="paramname"><em>encoded_buffer</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t * </td>
- <td class="paramname"><em>encoded_length</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Encodes a string into hex notation. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">buffer</td><td>String to encode into hex notiation </td></tr>
- <tr><td class="paramname">encoded_buffer</td><td>The buffer receives a hex encoded string </td></tr>
- <tr><td class="paramname">encoded_length</td><td>Length of the hex encoded string </td></tr>
- </table>
- </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>
|