libimobiledevice-doc 1.2.0+dfsg-3~ubuntu0.2 / usr / share / doc / libimobiledevice-doc / libimobiledevice / service_8h.html

This file is indexed.

/usr/share/doc/libimobiledevice-doc/libimobiledevice/service_8h.html is in libimobiledevice-doc 1.2.0+dfsg-3~ubuntu0.2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
<!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/service.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
   &#160;<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&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;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&#160;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> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">service.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Generic basic service implementation to inherit.  
<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:afde4ce2a541d4f756f6f09272d81ba55"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afde4ce2a541d4f756f6f09272d81ba55"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SERVICE_CONSTRUCTOR</b>(x)&#160;&#160;&#160;(int32_t (*)(<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>, lockdownd_service_descriptor_t, void**))(x)</td></tr>
<tr class="separator:afde4ce2a541d4f756f6f09272d81ba55"><td class="memSeparator" colspan="2">&#160;</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:a76edeaf13b26fdd6aacaa7c019cf8be1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76edeaf13b26fdd6aacaa7c019cf8be1"></a>
typedef struct <br class="typebreak" />
service_client_private&#160;</td><td class="memItemRight" valign="bottom"><b>service_client_private</b></td></tr>
<tr class="separator:a76edeaf13b26fdd6aacaa7c019cf8be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8facb34c6d02dd6ad4f8bd9ff64863b2"><td class="memItemLeft" align="right" valign="top">typedef service_client_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a></td></tr>
<tr class="memdesc:a8facb34c6d02dd6ad4f8bd9ff64863b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle.  <a href="#a8facb34c6d02dd6ad4f8bd9ff64863b2">More...</a><br /></td></tr>
<tr class="separator:a8facb34c6d02dd6ad4f8bd9ff64863b2"><td class="memSeparator" colspan="2">&#160;</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:ab1b8d81a36e39f4c84408195021c481a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1b8d81a36e39f4c84408195021c481a"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a> { <br />
&#160;&#160;<b>SERVICE_E_SUCCESS</b> = 0, 
<br />
&#160;&#160;<b>SERVICE_E_INVALID_ARG</b> = -1, 
<br />
&#160;&#160;<b>SERVICE_E_MUX_ERROR</b> = -3, 
<br />
&#160;&#160;<b>SERVICE_E_SSL_ERROR</b> = -4, 
<br />
&#160;&#160;<b>SERVICE_E_START_SERVICE_ERROR</b> = -5, 
<br />
&#160;&#160;<b>SERVICE_E_UNKNOWN_ERROR</b> = -256
<br />
 }</td></tr>
<tr class="memdesc:ab1b8d81a36e39f4c84408195021c481a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error Codes. <br /></td></tr>
<tr class="separator:ab1b8d81a36e39f4c84408195021c481a"><td class="memSeparator" colspan="2">&#160;</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:a0339969bcd8be611e6fcdb0bb394b1d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="service_8h.html#a0339969bcd8be611e6fcdb0bb394b1d3">service_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a> *client)</td></tr>
<tr class="memdesc:a0339969bcd8be611e6fcdb0bb394b1d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new service for the specified service descriptor.  <a href="#a0339969bcd8be611e6fcdb0bb394b1d3">More...</a><br /></td></tr>
<tr class="separator:a0339969bcd8be611e6fcdb0bb394b1d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78eb4ba60b93ed6bad0e372ab3c8433e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="service_8h.html#a78eb4ba60b93ed6bad0e372ab3c8433e">service_client_factory_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, const char *service_name, void **client, const char *label, int32_t(*constructor_func)(<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>, lockdownd_service_descriptor_t, void **), int32_t *error_code)</td></tr>
<tr class="memdesc:a78eb4ba60b93ed6bad0e372ab3c8433e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a new service on the specified device with given name and connects to it.  <a href="#a78eb4ba60b93ed6bad0e372ab3c8433e">More...</a><br /></td></tr>
<tr class="separator:a78eb4ba60b93ed6bad0e372ab3c8433e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91bbf08c5a5c1a46aa83728eb2dcd38f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="service_8h.html#a91bbf08c5a5c1a46aa83728eb2dcd38f">service_client_free</a> (<a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a> client)</td></tr>
<tr class="memdesc:a91bbf08c5a5c1a46aa83728eb2dcd38f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees a service instance.  <a href="#a91bbf08c5a5c1a46aa83728eb2dcd38f">More...</a><br /></td></tr>
<tr class="separator:a91bbf08c5a5c1a46aa83728eb2dcd38f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a533a9954c34a979072cb35d27749909e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="service_8h.html#a533a9954c34a979072cb35d27749909e">service_send</a> (<a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a> client, const char *data, uint32_t size, uint32_t *sent)</td></tr>
<tr class="memdesc:a533a9954c34a979072cb35d27749909e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends data using the given service client.  <a href="#a533a9954c34a979072cb35d27749909e">More...</a><br /></td></tr>
<tr class="separator:a533a9954c34a979072cb35d27749909e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a805c22db575715565a29893e4ddc2b95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="service_8h.html#a805c22db575715565a29893e4ddc2b95">service_receive_with_timeout</a> (<a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a> client, char *data, uint32_t size, uint32_t *received, unsigned int timeout)</td></tr>
<tr class="memdesc:a805c22db575715565a29893e4ddc2b95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives data using the given service client with specified timeout.  <a href="#a805c22db575715565a29893e4ddc2b95">More...</a><br /></td></tr>
<tr class="separator:a805c22db575715565a29893e4ddc2b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3adafaea2844f9ad22563c4eec42e38b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="service_8h.html#a3adafaea2844f9ad22563c4eec42e38b">service_receive</a> (<a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a> client, char *data, uint32_t size, uint32_t *received)</td></tr>
<tr class="memdesc:a3adafaea2844f9ad22563c4eec42e38b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives data using the given service client.  <a href="#a3adafaea2844f9ad22563c4eec42e38b">More...</a><br /></td></tr>
<tr class="separator:a3adafaea2844f9ad22563c4eec42e38b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c7a44d218b7a4f234dfa358dfc8e8a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="service_8h.html#a0c7a44d218b7a4f234dfa358dfc8e8a0">service_enable_ssl</a> (<a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a> client)</td></tr>
<tr class="memdesc:a0c7a44d218b7a4f234dfa358dfc8e8a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable SSL for the given service client.  <a href="#a0c7a44d218b7a4f234dfa358dfc8e8a0">More...</a><br /></td></tr>
<tr class="separator:a0c7a44d218b7a4f234dfa358dfc8e8a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07b052fb2a90d544921948c249c263d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="service_8h.html#a07b052fb2a90d544921948c249c263d9">service_disable_ssl</a> (<a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a> client)</td></tr>
<tr class="memdesc:a07b052fb2a90d544921948c249c263d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable SSL for the given service client.  <a href="#a07b052fb2a90d544921948c249c263d9">More...</a><br /></td></tr>
<tr class="separator:a07b052fb2a90d544921948c249c263d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Generic basic service implementation to inherit. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a8facb34c6d02dd6ad4f8bd9ff64863b2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef service_client_private* <a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The client handle. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a78eb4ba60b93ed6bad0e372ab3c8433e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a> service_client_factory_start_service </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
          <td class="paramname"><em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>service_name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void **&#160;</td>
          <td class="paramname"><em>client</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>label</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t(*)(<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>, lockdownd_service_descriptor_t, void **)&#160;</td>
          <td class="paramname"><em>constructor_func</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t *&#160;</td>
          <td class="paramname"><em>error_code</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Starts a new service on the specified device with given name 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">service_name</td><td>The name of the service to start. </td></tr>
    <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated service_client_t upon successful return. Must be freed using <a class="el" href="service_8h.html#a91bbf08c5a5c1a46aa83728eb2dcd38f" title="Frees a service instance. ">service_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>SERVICE_E_SUCCESS on success, or a SERVICE_E_* error code otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="a91bbf08c5a5c1a46aa83728eb2dcd38f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a> service_client_free </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a>&#160;</td>
          <td class="paramname"><em>client</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Frees a service instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">client</td><td>The service instance to free.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG when client is invalid, or a SERVICE_E_UNKNOWN_ERROR when another error occured. </dd></dl>

</div>
</div>
<a class="anchor" id="a0339969bcd8be611e6fcdb0bb394b1d3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a> service_client_new </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
          <td class="paramname"><em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">lockdownd_service_descriptor_t&#160;</td>
          <td class="paramname"><em>service</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a> *&#160;</td>
          <td class="paramname"><em>client</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a new service for the specified service descriptor. </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 be set to a newly allocated service_client_t upon successful return.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG when one of the arguments is invalid, or SERVICE_E_MUX_ERROR when connecting to the device failed. </dd></dl>

</div>
</div>
<a class="anchor" id="a07b052fb2a90d544921948c249c263d9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a> service_disable_ssl </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a>&#160;</td>
          <td class="paramname"><em>client</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disable SSL for the given service client. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">client</td><td>The connected service client for that SSL should be disabled.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG if client or client-&gt;connection is NULL, or SERVICE_E_UNKNOWN_ERROR otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="a0c7a44d218b7a4f234dfa358dfc8e8a0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a> service_enable_ssl </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a>&#160;</td>
          <td class="paramname"><em>client</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable SSL for the given service client. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">client</td><td>The connected service client for that SSL should be enabled.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG if client or client-&gt;connection is NULL, SERVICE_E_SSL_ERROR when SSL could not be enabled, or SERVICE_E_UNKNOWN_ERROR otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="a3adafaea2844f9ad22563c4eec42e38b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a> service_receive </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a>&#160;</td>
          <td class="paramname"><em>client</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>received</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Receives data using the given service client. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">client</td><td>The service 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>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG when one or more parameters are invalid, SERVICE_E_MUX_ERROR when a communication error occurs, or SERVICE_E_UNKNOWN_ERROR when an unspecified error occurs. </dd></dl>

</div>
</div>
<a class="anchor" id="a805c22db575715565a29893e4ddc2b95"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a> service_receive_with_timeout </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a>&#160;</td>
          <td class="paramname"><em>client</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>received</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>timeout</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Receives data using the given service client with specified timeout. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">client</td><td>The service 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>SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG when one or more parameters are invalid, SERVICE_E_MUX_ERROR when a communication error occurs, or SERVICE_E_UNKNOWN_ERROR when an unspecified error occurs. </dd></dl>

</div>
</div>
<a class="anchor" id="a533a9954c34a979072cb35d27749909e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="service_8h.html#ab1b8d81a36e39f4c84408195021c481a">service_error_t</a> service_send </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="service_8h.html#a8facb34c6d02dd6ad4f8bd9ff64863b2">service_client_t</a>&#160;</td>
          <td class="paramname"><em>client</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>sent</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sends data using the given service client. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">client</td><td>The service 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>SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG when one or more parameters are invalid, or SERVICE_E_UNKNOWN_ERROR when an unspecified error occurs. </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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.