-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhttp_8h.html
More file actions
1485 lines (1405 loc) · 119 KB
/
http_8h.html
File metadata and controls
1485 lines (1405 loc) · 119 KB
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
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ah_http/include/ah/http.h File Reference - Eclipse Arrowhead™ Core C Libraries</title>
<script src="jquery.js"></script>
<script src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script>
window.addEventListener("load", () => {
let contents = document.querySelector("body > div.contents");
if (!contents) {
return;
}
document.querySelectorAll("#top ul > li.current > a > span").forEach((selectedMenuItem) => {
contents.classList.add(selectedMenuItem.innerText.trim().toLowerCase().replace(/\s+/, "-"));
});
for (let i = contents.childNodes.length - 1; i >= 0; i -= 1) {
let childNode = contents.childNodes.item(i);
if ((childNode.nodeType === 3 && childNode.textContent.trim().length === 0)
|| (childNode.nodeType === 1 && childNode.classList.contains("textblock") && childNode.textContent.trim().length === 0)) {
childNode.remove();
}
}
});
</script>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="DoxygenStyle.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top">
<header>
<img alt="Logo" src="arrowhead-logo-white.svg"/>
<h1>Eclipse Arrowhead™ Core C Libraries <span class="version"></span></h1>
</header>
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Overview</span></a></li>
<li><a href="files.html"><span>Headers</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_3583a647cf2eebbd3a049e8fa52f244e.html">ah_http</a></li><li class="navelem"><a class="el" href="dir_859d411e738c53b77ebe00580c150c56.html">include</a></li><li class="navelem"><a class="el" href="dir_ead88d34a1645f90205f09becd3a194c.html">ah</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle"><div class="title">http.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >HTTP/1 client and server. </p>
<p >Here, data structures and functions are provided for representing, setting up and communicating via HTTP/1 clients and servers. To learn more about HTTP/1, itself please refer to <a href="https://rfc-editor.org/rfc/rfc9110.html">RFC9110</a>. Below, we briefly describe how to use this C API.</p>
<h3>Clients</h3>
<p >HTTP clients are set up using <a class="el" href="http_8h.html#aba6230b627c5522ff6e9c8cf3e13feb7" title="Initializes cln for subsequent use.">ah_http_client_init()</a>, <a class="el" href="http_8h.html#a3407248cc10199c91877397d823f6c37" title="Schedules opening of cln, which must be initialized, and its binding to the local network interface r...">ah_http_client_open()</a> and <a class="el" href="http_8h.html#a2b95d0ccdc86388438d99fdfc65d45e2" title="Schedules connection of cln, which must be open, to raddr.">ah_http_client_connect()</a>, in that order. Successfully initialized clients are terminated with <a class="el" href="http_8h.html#a64bab29aa1d7a7a0b35dcac9ea9a00fb" title="Terminates cln, releasing any resources it may hold.">ah_http_client_term()</a> and successfully opened clients are closed with <a class="el" href="http_8h.html#a4a0cacd784a5c0c3dc2b0af93745d02a" title="Schedules closing of cln.">ah_http_client_close()</a>. Every client receives data, and is notified of other events, via a callback set of type <a class="el" href="structah__http__client__cbs.html" title="HTTP client callback set.">ah_http_client_cbs</a>. To send a message, you must provide a certain client with a <em>head</em>, a number of <em>body parts</em> and indicate the end of the message. The head and body parts are added to the <em>send queue</em> of the client, which is processed and emptied asynchronously when possible. The message head, which consists of a <em>start line</em> and zero or more headers, is added by a call to <a class="el" href="http_8h.html#afdfe56387101bf4b1bb954f002fa3ef2" title="Schedules sending of HTTP message head.">ah_http_client_send_head()</a>. After a head has been successfully submitted, you must continue in one of the following ways:</p>
<ol>
<li>
If <em>no message body</em> is to be sent, call <a class="el" href="http_8h.html#a684e4861788b51a68e3ed308aa20d6cf" title="Ends current HTTP message of cln.">ah_http_client_send_end()</a> directly. </li>
<li>
If a <em>non-chunked body</em> is to be sent, which is recommended when the final size of the send body is <em>known</em> in advance, call <a class="el" href="http_8h.html#a038276fcd4deb032722bc2104c8fdb2b" title="Schedules sending of HTTP message body data.">ah_http_client_send_data()</a> repeatedly until all body parts have been added. Finally, call <a class="el" href="http_8h.html#a684e4861788b51a68e3ed308aa20d6cf" title="Ends current HTTP message of cln.">ah_http_client_send_end()</a> to end the message. </li>
<li>
If a <em>chunked body</em> is to be sent, which is recommended when the final size of the send body is <em>not known</em> in advance, call <a class="el" href="http_8h.html#a95ac1840f6f2b2ae9d8a0b32e1366d79" title="Schedules sending of HTTP message body data in the form of a chunk.">ah_http_client_send_chunk()</a> repeatedly until all body chunks have been added. Finally, call <a class="el" href="http_8h.html#aef012c485382dc1051919809f266021e" title="Schedules sending of last chunk and trailer of and ends the current message of cln.">ah_http_client_send_trailer()</a> to submit any last chunk extension and trailer headers, as well as to indicate the end of the current message. </li>
</ol>
<p >When sending and receiving <em>metadata</em>, such as start lines, headers and chunks, that metadata is gathered automatically into dynamically allocated buffers. Each client owns one such buffer it reuses for all data it receives. Another is allocated for the duration of each on-going message send procedure. If a certain metadata item, such as a header or chunk extension, exceeds the size of its receive buffer, or a send buffer is too small to contain <em>all</em> relevant metadata items, the message transmission is failed with error code <a class="el" href="err_8h.html#a65a9889d59795edbe23364fd1f8e7752">AH_EOVERFLOW</a>. Limiting sizes in this way helps reduce the complexity the client implementation and works as a form of protection from exploits that use large metadata items. Generally, the size of each of these buffers will be limited by the page allocator page size, <a class="el" href="alloc_8h.html#acf3a4492f083f0f4868f515f16441070">AH_PSIZE</a>, more of which you can read in the documentation for <a class="el" href="alloc_8h.html#a911d4e66ad39e4007ef01aec5a0ec06a" title="Allocates a page of memory, guaranteed to be at least AH_PSIZE bytes large.">ah_palloc()</a>.</p>
<h3>Servers</h3>
<p >HTTP servers are set up using <a class="el" href="http_8h.html#a481c2847576b4f3cbfaa6524af2f36a7" title="Initializes srv for subsequent use.">ah_http_server_init()</a>, <a class="el" href="http_8h.html#afef6c8c9a8201ce16aece2ea9d74a7e8" title="Schedules opening of srv, which must be initialized, and its binding to the local network interface r...">ah_http_server_open()</a> and <a class="el" href="http_8h.html#a99d76f255529dfb4a1604e97a7fbe90c" title="Schedules for srv, which must be open, to start listening for connecting clients.">ah_http_server_listen()</a>. Successfully initialized servers are terminated with <a class="el" href="http_8h.html#adb9f40bf74053ecfec1718e13f18bcf0" title="Terminates srv, freeing any resources it holds.">ah_http_server_term()</a> and successfully opened servers are closed with <a class="el" href="http_8h.html#ae9def4c4323d8884edd607006b650ae1" title="Schedules closing of srv.">ah_http_server_close()</a>. Servers receive incoming clients and are notified of other events via their callback sets, which are of type <a class="el" href="structah__http__server__cbs.html" title="HTTP server callback set.">ah_http_server_cbs</a>.</p>
<h3>Automatic Headers</h3>
<p >As described in the directory-level documentation for this library, only a small subset of all headers part of the HTTP standards are handled automatically. Those headers are outlined in the below table.</p>
<a class="anchor" id="http-headers"></a>
<table class="doxtable">
<caption>Automatically Handled HTTP Headers</caption>
<tr>
<th>Header </th><th>Automatic Behavior </th></tr>
<tr>
<td><code>Connection</code> </td><td>The options (1) <code>close</code> and (2) <code>keep-alive</code> automatically cause HTTP connections to either (1) be closed after the current request/response exchange or (2) remain open between exchanges. Which of the two behaviors represented by these options is the default varies between HTTP versions. In version 1.0 <code>close</code> is the default, while on all subsequent versions <code>keep-alive</code> is the default. </td></tr>
<tr>
<td><code>Content-Length</code> </td><td>When receiving incoming requests and responses, the <code>Content-Length</code> is used automatically to determine when and if a message body is expected, and when all of it has been received. Incoming messages that neither specify a <code>Content-Length</code> nor <code>Transfer-Encoding: chunked</code> are assumed to not have bodies at all. Note that no <code>Content-Length</code> header is added automatically to sent requests or responses. You must make sure to add it when relevant. </td></tr>
<tr>
<td><code>Host</code> </td><td>When sending requests, if this header is left unspecified and the used HTTP version is 1.1 or higher, the header is automatically populated with the IP address and port number of the targeted server. </td></tr>
<tr>
<td><code>Transfer-Encoding</code> </td><td>If <code>Transfer-Encoding: chunked</code> is specified in an incoming request or response, the individual chunks are decoded and presented automatically. Other transfer encoding options are ignored. This means that body compression and decompression is not handled automatically. </td></tr>
</table>
<dl class="section see"><dt>See also</dt><dd><a href="https://rfc-editor.org/rfc/rfc9110.html">https://rfc-editor.org/rfc/rfc9110.html</a> </dd>
<dd>
<a href="https://rfc-editor.org/rfc/rfc9112.html">https://rfc-editor.org/rfc/rfc9112.html</a> </dd></dl>
</div>
<p><a href="http_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structah__http__chunk.html">ah_http_chunk</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HTTP chunk, including data and an arbitrary extension. <a href="structah__http__chunk.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structah__http__client.html">ah_http_client</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HTTP client. <a href="structah__http__client.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structah__http__client__cbs.html">ah_http_client_cbs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HTTP client callback set. <a href="structah__http__client__cbs.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structah__http__client__obs.html">ah_http_client_obs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HTTP client observer. <a href="structah__http__client__obs.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structah__http__head.html">ah_http_head</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HTTP start line and field lines. <a href="structah__http__head.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structah__http__header.html">ah_http_header</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HTTP header field, which is a name/value pair. <a href="structah__http__header.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structah__http__server.html">ah_http_server</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HTTP server. <a href="structah__http__server.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structah__http__server__cbs.html">ah_http_server_cbs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HTTP server callback set. <a href="structah__http__server__cbs.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structah__http__server__obs.html">ah_http_server_obs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HTTP server observer. <a href="structah__http__server__obs.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structah__http__trailer.html">ah_http_trailer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HTTP chunked message end, consisting of a last chunk extension and a trailer. <a href="structah__http__trailer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structah__http__ver.html">ah_http_ver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HTTP version indicator. <a href="structah__http__ver.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:acffe2c2d672ade0d53546e2f133a471c"><td class="memItemLeft" align="right" valign="top"><a id="acffe2c2d672ade0d53546e2f133a471c" name="acffe2c2d672ade0d53546e2f133a471c"></a>
#define </td><td class="memItemRight" valign="bottom"><b>AH_HTTP_VERSION_MAJOR</b>   AH_I_HTTP_VERSION_MAJOR</td></tr>
<tr class="memdesc:acffe2c2d672ade0d53546e2f133a471c"><td class="mdescLeft"> </td><td class="mdescRight">Major version of the HTTP library, represented by an unsigned integer literal. <br /></td></tr>
<tr class="separator:acffe2c2d672ade0d53546e2f133a471c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7406c21229291db53c74df46941df74f"><td class="memItemLeft" align="right" valign="top"><a id="a7406c21229291db53c74df46941df74f" name="a7406c21229291db53c74df46941df74f"></a>
#define </td><td class="memItemRight" valign="bottom"><b>AH_HTTP_VERSION_MINOR</b>   AH_I_HTTP_VERSION_MINOR</td></tr>
<tr class="memdesc:a7406c21229291db53c74df46941df74f"><td class="mdescLeft"> </td><td class="mdescRight">Minor version of the HTTP library, represented by an unsigned integer literal. <br /></td></tr>
<tr class="separator:a7406c21229291db53c74df46941df74f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae16d61801758beff1dfabddf278a6d20"><td class="memItemLeft" align="right" valign="top"><a id="ae16d61801758beff1dfabddf278a6d20" name="ae16d61801758beff1dfabddf278a6d20"></a>
#define </td><td class="memItemRight" valign="bottom"><b>AH_HTTP_VERSION_PATCH</b>   AH_I_HTTP_VERSION_PATCH</td></tr>
<tr class="memdesc:ae16d61801758beff1dfabddf278a6d20"><td class="mdescLeft"> </td><td class="mdescRight">Patch version of the HTTP library, represented by an unsigned integer literal. <br /></td></tr>
<tr class="separator:ae16d61801758beff1dfabddf278a6d20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee82aceb495f1e5b3e7e7bd37cecf550"><td class="memItemLeft" align="right" valign="top"><a id="aee82aceb495f1e5b3e7e7bd37cecf550" name="aee82aceb495f1e5b3e7e7bd37cecf550"></a>
#define </td><td class="memItemRight" valign="bottom"><b>AH_HTTP_VERSION_STR</b>   AH_I_HTTP_VERSION_STR</td></tr>
<tr class="memdesc:aee82aceb495f1e5b3e7e7bd37cecf550"><td class="mdescLeft"> </td><td class="mdescRight">Constant string representation of the HTTP library version. <br /></td></tr>
<tr class="separator:aee82aceb495f1e5b3e7e7bd37cecf550"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:acc6152c1aa650c9a8625a762d03acbca"><td class="memItemLeft" align="right" valign="top"><a id="acc6152c1aa650c9a8625a762d03acbca" name="acc6152c1aa650c9a8625a762d03acbca"></a>
typedef struct <a class="el" href="structah__http__chunk.html">ah_http_chunk</a> </td><td class="memItemRight" valign="bottom"><b>ah_http_chunk_t</b></td></tr>
<tr class="separator:acc6152c1aa650c9a8625a762d03acbca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a274e21c845eb157c60055b95afd6421a"><td class="memItemLeft" align="right" valign="top"><a id="a274e21c845eb157c60055b95afd6421a" name="a274e21c845eb157c60055b95afd6421a"></a>
typedef struct <a class="el" href="structah__http__client__cbs.html">ah_http_client_cbs</a> </td><td class="memItemRight" valign="bottom"><b>ah_http_client_cbs_t</b></td></tr>
<tr class="separator:a274e21c845eb157c60055b95afd6421a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab5fe2d607c221a40ee0ffc5657f3bb4c"><td class="memItemLeft" align="right" valign="top"><a id="ab5fe2d607c221a40ee0ffc5657f3bb4c" name="ab5fe2d607c221a40ee0ffc5657f3bb4c"></a>
typedef struct <a class="el" href="structah__http__client__obs.html">ah_http_client_obs</a> </td><td class="memItemRight" valign="bottom"><b>ah_http_client_obs_t</b></td></tr>
<tr class="separator:ab5fe2d607c221a40ee0ffc5657f3bb4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9fa0a0f04701dd307804c9cb720b0fd"><td class="memItemLeft" align="right" valign="top"><a id="ac9fa0a0f04701dd307804c9cb720b0fd" name="ac9fa0a0f04701dd307804c9cb720b0fd"></a>
typedef struct <a class="el" href="structah__http__client.html">ah_http_client</a> </td><td class="memItemRight" valign="bottom"><b>ah_http_client_t</b></td></tr>
<tr class="separator:ac9fa0a0f04701dd307804c9cb720b0fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7c925ab9062849b933fbe9473a2bfc1"><td class="memItemLeft" align="right" valign="top"><a id="ad7c925ab9062849b933fbe9473a2bfc1" name="ad7c925ab9062849b933fbe9473a2bfc1"></a>
typedef struct <a class="el" href="structah__http__head.html">ah_http_head</a> </td><td class="memItemRight" valign="bottom"><b>ah_http_head_t</b></td></tr>
<tr class="separator:ad7c925ab9062849b933fbe9473a2bfc1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0efb434bfbc45e177725a8da6e208a1"><td class="memItemLeft" align="right" valign="top"><a id="ad0efb434bfbc45e177725a8da6e208a1" name="ad0efb434bfbc45e177725a8da6e208a1"></a>
typedef struct <a class="el" href="structah__http__header.html">ah_http_header</a> </td><td class="memItemRight" valign="bottom"><b>ah_http_header_t</b></td></tr>
<tr class="separator:ad0efb434bfbc45e177725a8da6e208a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86a0c0eca7fe697c83c0f8383da30949"><td class="memItemLeft" align="right" valign="top"><a id="a86a0c0eca7fe697c83c0f8383da30949" name="a86a0c0eca7fe697c83c0f8383da30949"></a>
typedef struct <a class="el" href="structah__http__server__cbs.html">ah_http_server_cbs</a> </td><td class="memItemRight" valign="bottom"><b>ah_http_server_cbs_t</b></td></tr>
<tr class="separator:a86a0c0eca7fe697c83c0f8383da30949"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc32aa7c5897f752848ed9ddde73e279"><td class="memItemLeft" align="right" valign="top"><a id="abc32aa7c5897f752848ed9ddde73e279" name="abc32aa7c5897f752848ed9ddde73e279"></a>
typedef struct <a class="el" href="structah__http__server__obs.html">ah_http_server_obs</a> </td><td class="memItemRight" valign="bottom"><b>ah_http_server_obs_t</b></td></tr>
<tr class="separator:abc32aa7c5897f752848ed9ddde73e279"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab180b33e0760a002403afb04e7ceec7d"><td class="memItemLeft" align="right" valign="top"><a id="ab180b33e0760a002403afb04e7ceec7d" name="ab180b33e0760a002403afb04e7ceec7d"></a>
typedef struct <a class="el" href="structah__http__server.html">ah_http_server</a> </td><td class="memItemRight" valign="bottom"><b>ah_http_server_t</b></td></tr>
<tr class="separator:ab180b33e0760a002403afb04e7ceec7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab50e664ab20bed89c085daa63976007a"><td class="memItemLeft" align="right" valign="top"><a id="ab50e664ab20bed89c085daa63976007a" name="ab50e664ab20bed89c085daa63976007a"></a>
typedef struct <a class="el" href="structah__http__trailer.html">ah_http_trailer</a> </td><td class="memItemRight" valign="bottom"><b>ah_http_trailer_t</b></td></tr>
<tr class="separator:ab50e664ab20bed89c085daa63976007a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a701c0bcbac543da1ea730b9f7f73ee9f"><td class="memItemLeft" align="right" valign="top"><a id="a701c0bcbac543da1ea730b9f7f73ee9f" name="a701c0bcbac543da1ea730b9f7f73ee9f"></a>
typedef struct <a class="el" href="structah__http__ver.html">ah_http_ver</a> </td><td class="memItemRight" valign="bottom"><b>ah_http_ver_t</b></td></tr>
<tr class="separator:a701c0bcbac543da1ea730b9f7f73ee9f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">HTTP Client</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p >Operations on <a class="el" href="structah__http__client.html" title="HTTP client.">ah_http_client</a> instances.</p>
<p >All such instances must be initialized using <a class="el" href="http_8h.html#aba6230b627c5522ff6e9c8cf3e13feb7" title="Initializes cln for subsequent use.">ah_http_client_init()</a> before they are provided to any other functions listed here. Any other requirements regarding the state of clients are described in the documentation of each respective function, sometimes only via the error codes it lists. </p>
</div></td></tr>
<tr class="memitem:a4a0cacd784a5c0c3dc2b0af93745d02a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a4a0cacd784a5c0c3dc2b0af93745d02a">ah_http_client_close</a> (<a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln)</td></tr>
<tr class="memdesc:a4a0cacd784a5c0c3dc2b0af93745d02a"><td class="mdescLeft"> </td><td class="mdescRight">Schedules closing of <em>cln</em>. <a href="http_8h.html#a4a0cacd784a5c0c3dc2b0af93745d02a">More...</a><br /></td></tr>
<tr class="separator:a4a0cacd784a5c0c3dc2b0af93745d02a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b95d0ccdc86388438d99fdfc65d45e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a2b95d0ccdc86388438d99fdfc65d45e2">ah_http_client_connect</a> (<a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln, const <a class="el" href="unionah__sockaddr.html">ah_sockaddr_t</a> *raddr)</td></tr>
<tr class="memdesc:a2b95d0ccdc86388438d99fdfc65d45e2"><td class="mdescLeft"> </td><td class="mdescRight">Schedules connection of <em>cln</em>, which must be open, to <em>raddr</em>. <a href="http_8h.html#a2b95d0ccdc86388438d99fdfc65d45e2">More...</a><br /></td></tr>
<tr class="separator:a2b95d0ccdc86388438d99fdfc65d45e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0459cfe2bd9f389b7ce586a8a3dcea3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="structah__tcp__conn.html">ah_tcp_conn_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a0459cfe2bd9f389b7ce586a8a3dcea3e">ah_http_client_get_conn</a> (<a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln)</td></tr>
<tr class="memdesc:a0459cfe2bd9f389b7ce586a8a3dcea3e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the TCP connection of <em>cln</em>. <a href="http_8h.html#a0459cfe2bd9f389b7ce586a8a3dcea3e">More...</a><br /></td></tr>
<tr class="separator:a0459cfe2bd9f389b7ce586a8a3dcea3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b622e70c0e84c971414994077bbed95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a1b622e70c0e84c971414994077bbed95">ah_http_client_get_laddr</a> (const <a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln, <a class="el" href="unionah__sockaddr.html">ah_sockaddr_t</a> *laddr)</td></tr>
<tr class="memdesc:a1b622e70c0e84c971414994077bbed95"><td class="mdescLeft"> </td><td class="mdescRight">Stores local address bound by <em>cln</em> into <em>laddr</em>. <a href="http_8h.html#a1b622e70c0e84c971414994077bbed95">More...</a><br /></td></tr>
<tr class="separator:a1b622e70c0e84c971414994077bbed95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ecd3e6fb122fcd92d181b0f31f7e931"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="structah__loop.html">ah_loop_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a2ecd3e6fb122fcd92d181b0f31f7e931">ah_http_client_get_loop</a> (const <a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln)</td></tr>
<tr class="memdesc:a2ecd3e6fb122fcd92d181b0f31f7e931"><td class="mdescLeft"> </td><td class="mdescRight">Gets pointer to event loop of <em>cln</em>. <a href="http_8h.html#a2ecd3e6fb122fcd92d181b0f31f7e931">More...</a><br /></td></tr>
<tr class="separator:a2ecd3e6fb122fcd92d181b0f31f7e931"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a4114087cf499bd5ebc44a4b555c261"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> void * </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a0a4114087cf499bd5ebc44a4b555c261">ah_http_client_get_obs_ctx</a> (const <a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln)</td></tr>
<tr class="memdesc:a0a4114087cf499bd5ebc44a4b555c261"><td class="mdescLeft"> </td><td class="mdescRight">Gets the context pointer of the client observer associated with <em>srv</em>. <a href="http_8h.html#a0a4114087cf499bd5ebc44a4b555c261">More...</a><br /></td></tr>
<tr class="separator:a0a4114087cf499bd5ebc44a4b555c261"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a816bbf2d1973884cb3a8787e219eaf35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a816bbf2d1973884cb3a8787e219eaf35">ah_http_client_get_raddr</a> (const <a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln, <a class="el" href="unionah__sockaddr.html">ah_sockaddr_t</a> *raddr)</td></tr>
<tr class="memdesc:a816bbf2d1973884cb3a8787e219eaf35"><td class="mdescLeft"> </td><td class="mdescRight">Stores remote address of <em>cln</em> into <em>raddr</em>. <a href="http_8h.html#a816bbf2d1973884cb3a8787e219eaf35">More...</a><br /></td></tr>
<tr class="separator:a816bbf2d1973884cb3a8787e219eaf35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba6230b627c5522ff6e9c8cf3e13feb7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#aba6230b627c5522ff6e9c8cf3e13feb7">ah_http_client_init</a> (<a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln, <a class="el" href="structah__loop.html">ah_loop_t</a> *loop, <a class="el" href="structah__tcp__trans.html">ah_tcp_trans_t</a> trans, <a class="el" href="structah__http__client__obs.html">ah_http_client_obs_t</a> obs)</td></tr>
<tr class="memdesc:aba6230b627c5522ff6e9c8cf3e13feb7"><td class="mdescLeft"> </td><td class="mdescRight">Initializes <em>cln</em> for subsequent use. <a href="http_8h.html#aba6230b627c5522ff6e9c8cf3e13feb7">More...</a><br /></td></tr>
<tr class="separator:aba6230b627c5522ff6e9c8cf3e13feb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3407248cc10199c91877397d823f6c37"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a3407248cc10199c91877397d823f6c37">ah_http_client_open</a> (<a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln, const <a class="el" href="unionah__sockaddr.html">ah_sockaddr_t</a> *laddr)</td></tr>
<tr class="memdesc:a3407248cc10199c91877397d823f6c37"><td class="mdescLeft"> </td><td class="mdescRight">Schedules opening of <em>cln</em>, which must be initialized, and its binding to the local network interface represented by <em>laddr</em>. <a href="http_8h.html#a3407248cc10199c91877397d823f6c37">More...</a><br /></td></tr>
<tr class="separator:a3407248cc10199c91877397d823f6c37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95ac1840f6f2b2ae9d8a0b32e1366d79"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a95ac1840f6f2b2ae9d8a0b32e1366d79">ah_http_client_send_chunk</a> (<a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln, <a class="el" href="structah__http__chunk.html">ah_http_chunk_t</a> *chunk)</td></tr>
<tr class="memdesc:a95ac1840f6f2b2ae9d8a0b32e1366d79"><td class="mdescLeft"> </td><td class="mdescRight">Schedules sending of HTTP message body data in the form of a <em>chunk</em>. <a href="http_8h.html#a95ac1840f6f2b2ae9d8a0b32e1366d79">More...</a><br /></td></tr>
<tr class="separator:a95ac1840f6f2b2ae9d8a0b32e1366d79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a038276fcd4deb032722bc2104c8fdb2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a038276fcd4deb032722bc2104c8fdb2b">ah_http_client_send_data</a> (<a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln, <a class="el" href="structah__tcp__out.html">ah_tcp_out_t</a> *out)</td></tr>
<tr class="memdesc:a038276fcd4deb032722bc2104c8fdb2b"><td class="mdescLeft"> </td><td class="mdescRight">Schedules sending of HTTP message body data. <a href="http_8h.html#a038276fcd4deb032722bc2104c8fdb2b">More...</a><br /></td></tr>
<tr class="separator:a038276fcd4deb032722bc2104c8fdb2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a684e4861788b51a68e3ed308aa20d6cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a684e4861788b51a68e3ed308aa20d6cf">ah_http_client_send_end</a> (<a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln)</td></tr>
<tr class="memdesc:a684e4861788b51a68e3ed308aa20d6cf"><td class="mdescLeft"> </td><td class="mdescRight">Ends current HTTP message of <em>cln</em>. <a href="http_8h.html#a684e4861788b51a68e3ed308aa20d6cf">More...</a><br /></td></tr>
<tr class="separator:a684e4861788b51a68e3ed308aa20d6cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afdfe56387101bf4b1bb954f002fa3ef2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#afdfe56387101bf4b1bb954f002fa3ef2">ah_http_client_send_head</a> (<a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln, <a class="el" href="structah__http__head.html">ah_http_head_t</a> *head)</td></tr>
<tr class="memdesc:afdfe56387101bf4b1bb954f002fa3ef2"><td class="mdescLeft"> </td><td class="mdescRight">Schedules sending of HTTP message head. <a href="http_8h.html#afdfe56387101bf4b1bb954f002fa3ef2">More...</a><br /></td></tr>
<tr class="separator:afdfe56387101bf4b1bb954f002fa3ef2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef012c485382dc1051919809f266021e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#aef012c485382dc1051919809f266021e">ah_http_client_send_trailer</a> (<a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln, <a class="el" href="structah__http__trailer.html">ah_http_trailer_t</a> *trailer)</td></tr>
<tr class="memdesc:aef012c485382dc1051919809f266021e"><td class="mdescLeft"> </td><td class="mdescRight">Schedules sending of last chunk and trailer of and ends the current message of <em>cln</em>. <a href="http_8h.html#aef012c485382dc1051919809f266021e">More...</a><br /></td></tr>
<tr class="separator:aef012c485382dc1051919809f266021e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64bab29aa1d7a7a0b35dcac9ea9a00fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a64bab29aa1d7a7a0b35dcac9ea9a00fb">ah_http_client_term</a> (<a class="el" href="structah__http__client.html">ah_http_client_t</a> *cln)</td></tr>
<tr class="memdesc:a64bab29aa1d7a7a0b35dcac9ea9a00fb"><td class="mdescLeft"> </td><td class="mdescRight">Terminates <em>cln</em>, releasing any resources it may hold. <a href="http_8h.html#a64bab29aa1d7a7a0b35dcac9ea9a00fb">More...</a><br /></td></tr>
<tr class="separator:a64bab29aa1d7a7a0b35dcac9ea9a00fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">HTTP Client Callback Sets</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p >Operations on <a class="el" href="structah__http__client__cbs.html" title="HTTP client callback set.">ah_http_client_cbs</a> instances. </p>
</div></td></tr>
<tr class="memitem:aa7e37041fb961caf21160ded7d0b0bc1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#aa7e37041fb961caf21160ded7d0b0bc1">ah_http_client_cbs_is_valid</a> (const <a class="el" href="structah__http__client__cbs.html">ah_http_client_cbs_t</a> *cbs)</td></tr>
<tr class="memdesc:aa7e37041fb961caf21160ded7d0b0bc1"><td class="mdescLeft"> </td><td class="mdescRight">Checks if <em>cbs</em> is valid for handling clients initiated locally. <a href="http_8h.html#aa7e37041fb961caf21160ded7d0b0bc1">More...</a><br /></td></tr>
<tr class="separator:aa7e37041fb961caf21160ded7d0b0bc1"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">HTTP Server</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p >Operations on <a class="el" href="structah__http__server.html" title="HTTP server.">ah_http_server</a> instances.</p>
<p >All such instances must be initialized using <a class="el" href="http_8h.html#a481c2847576b4f3cbfaa6524af2f36a7" title="Initializes srv for subsequent use.">ah_http_server_init()</a> before they are provided to any other functions listed here. Any other requirements regarding the state of servers are described in the documentation of each respective function, sometimes only via the error codes it lists. </p>
</div></td></tr>
<tr class="memitem:ae9def4c4323d8884edd607006b650ae1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#ae9def4c4323d8884edd607006b650ae1">ah_http_server_close</a> (<a class="el" href="structah__http__server.html">ah_http_server_t</a> *srv)</td></tr>
<tr class="memdesc:ae9def4c4323d8884edd607006b650ae1"><td class="mdescLeft"> </td><td class="mdescRight">Schedules closing of <em>srv</em>. <a href="http_8h.html#ae9def4c4323d8884edd607006b650ae1">More...</a><br /></td></tr>
<tr class="separator:ae9def4c4323d8884edd607006b650ae1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a361734cf37a2a850071de1038eae4b3c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a361734cf37a2a850071de1038eae4b3c">ah_http_server_get_laddr</a> (const <a class="el" href="structah__http__server.html">ah_http_server_t</a> *srv, <a class="el" href="unionah__sockaddr.html">ah_sockaddr_t</a> *laddr)</td></tr>
<tr class="memdesc:a361734cf37a2a850071de1038eae4b3c"><td class="mdescLeft"> </td><td class="mdescRight">Stores local address bound by <em>srv</em> into <em>laddr</em>. <a href="http_8h.html#a361734cf37a2a850071de1038eae4b3c">More...</a><br /></td></tr>
<tr class="separator:a361734cf37a2a850071de1038eae4b3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed1d897bd5505e739ffedabaa04e33d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="structah__tcp__listener.html">ah_tcp_listener_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#aed1d897bd5505e739ffedabaa04e33d6">ah_http_server_get_listener</a> (<a class="el" href="structah__http__server.html">ah_http_server_t</a> *srv)</td></tr>
<tr class="memdesc:aed1d897bd5505e739ffedabaa04e33d6"><td class="mdescLeft"> </td><td class="mdescRight">Gets the TCP listener of <em>srv</em>. <a href="http_8h.html#aed1d897bd5505e739ffedabaa04e33d6">More...</a><br /></td></tr>
<tr class="separator:aed1d897bd5505e739ffedabaa04e33d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05d424e3ea190fb884b10fcbfb7a6b31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="structah__loop.html">ah_loop_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a05d424e3ea190fb884b10fcbfb7a6b31">ah_http_server_get_loop</a> (const <a class="el" href="structah__http__server.html">ah_http_server_t</a> *srv)</td></tr>
<tr class="memdesc:a05d424e3ea190fb884b10fcbfb7a6b31"><td class="mdescLeft"> </td><td class="mdescRight">Gets pointer to event loop of <em>srv</em>. <a href="http_8h.html#a05d424e3ea190fb884b10fcbfb7a6b31">More...</a><br /></td></tr>
<tr class="separator:a05d424e3ea190fb884b10fcbfb7a6b31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a973c0bcf2b3409253896d15ea6073153"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> void * </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a973c0bcf2b3409253896d15ea6073153">ah_http_server_get_obs_ctx</a> (const <a class="el" href="structah__http__server.html">ah_http_server_t</a> *srv)</td></tr>
<tr class="memdesc:a973c0bcf2b3409253896d15ea6073153"><td class="mdescLeft"> </td><td class="mdescRight">Gets the context pointer of the server observer associated with <em>srv</em>. <a href="http_8h.html#a973c0bcf2b3409253896d15ea6073153">More...</a><br /></td></tr>
<tr class="separator:a973c0bcf2b3409253896d15ea6073153"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a481c2847576b4f3cbfaa6524af2f36a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a481c2847576b4f3cbfaa6524af2f36a7">ah_http_server_init</a> (<a class="el" href="structah__http__server.html">ah_http_server_t</a> *srv, <a class="el" href="structah__loop.html">ah_loop_t</a> *loop, <a class="el" href="structah__tcp__trans.html">ah_tcp_trans_t</a> trans, <a class="el" href="structah__http__server__obs.html">ah_http_server_obs_t</a> obs)</td></tr>
<tr class="memdesc:a481c2847576b4f3cbfaa6524af2f36a7"><td class="mdescLeft"> </td><td class="mdescRight">Initializes <em>srv</em> for subsequent use. <a href="http_8h.html#a481c2847576b4f3cbfaa6524af2f36a7">More...</a><br /></td></tr>
<tr class="separator:a481c2847576b4f3cbfaa6524af2f36a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99d76f255529dfb4a1604e97a7fbe90c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a99d76f255529dfb4a1604e97a7fbe90c">ah_http_server_listen</a> (<a class="el" href="structah__http__server.html">ah_http_server_t</a> *srv, unsigned backlog)</td></tr>
<tr class="memdesc:a99d76f255529dfb4a1604e97a7fbe90c"><td class="mdescLeft"> </td><td class="mdescRight">Schedules for <em>srv</em>, which must be open, to start listening for connecting clients. <a href="http_8h.html#a99d76f255529dfb4a1604e97a7fbe90c">More...</a><br /></td></tr>
<tr class="separator:a99d76f255529dfb4a1604e97a7fbe90c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afef6c8c9a8201ce16aece2ea9d74a7e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#afef6c8c9a8201ce16aece2ea9d74a7e8">ah_http_server_open</a> (<a class="el" href="structah__http__server.html">ah_http_server_t</a> *srv, const <a class="el" href="unionah__sockaddr.html">ah_sockaddr_t</a> *laddr)</td></tr>
<tr class="memdesc:afef6c8c9a8201ce16aece2ea9d74a7e8"><td class="mdescLeft"> </td><td class="mdescRight">Schedules opening of <em>srv</em>, which must be initialized, and its binding to the local network interface represented by <em>laddr</em>. <a href="http_8h.html#afef6c8c9a8201ce16aece2ea9d74a7e8">More...</a><br /></td></tr>
<tr class="separator:afef6c8c9a8201ce16aece2ea9d74a7e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb9f40bf74053ecfec1718e13f18bcf0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#adb9f40bf74053ecfec1718e13f18bcf0">ah_http_server_term</a> (<a class="el" href="structah__http__server.html">ah_http_server_t</a> *srv)</td></tr>
<tr class="memdesc:adb9f40bf74053ecfec1718e13f18bcf0"><td class="mdescLeft"> </td><td class="mdescRight">Terminates <em>srv</em>, freeing any resources it holds. <a href="http_8h.html#adb9f40bf74053ecfec1718e13f18bcf0">More...</a><br /></td></tr>
<tr class="separator:adb9f40bf74053ecfec1718e13f18bcf0"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">HTTP Server Callback Sets</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p >Operations on <a class="el" href="structah__http__server__cbs.html" title="HTTP server callback set.">ah_http_server_cbs</a> instances. </p>
</div></td></tr>
<tr class="memitem:a6b24355cd2c20fcd65fc08f763ef1972"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="http_8h.html#a6b24355cd2c20fcd65fc08f763ef1972">ah_http_server_cbs_is_valid</a> (const <a class="el" href="structah__http__server__cbs.html">ah_http_server_cbs_t</a> *cbs)</td></tr>
<tr class="memdesc:a6b24355cd2c20fcd65fc08f763ef1972"><td class="mdescLeft"> </td><td class="mdescRight">Checks if <em>cbs</em> is valid for handling servers initiated locally. <a href="http_8h.html#a6b24355cd2c20fcd65fc08f763ef1972">More...</a><br /></td></tr>
<tr class="separator:a6b24355cd2c20fcd65fc08f763ef1972"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="aa7e37041fb961caf21160ded7d0b0bc1" name="aa7e37041fb961caf21160ded7d0b0bc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7e37041fb961caf21160ded7d0b0bc1">◆ </a></span>ah_http_client_cbs_is_valid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> bool ah_http_client_cbs_is_valid </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structah__http__client__cbs.html">ah_http_client_cbs_t</a> * </td>
<td class="paramname"><em>cbs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if <em>cbs</em> is valid for handling clients initiated locally. </p>
<p >Such a valid callback set has all of its function pointers set.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cbs</td><td>Pointer to HTTP client callback set. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> only if <em>cbs</em> is <em>valid</em>. <code>false</code> otherwise. </dd></dl>
</div>
</div>
<a id="a4a0cacd784a5c0c3dc2b0af93745d02a" name="a4a0cacd784a5c0c3dc2b0af93745d02a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a0cacd784a5c0c3dc2b0af93745d02a">◆ </a></span>ah_http_client_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> ah_http_client_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Schedules closing of <em>cln</em>. </p>
<p >If the return value of this function is <a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a>, meaning that the closing could indeed be scheduled, its result will eventually be presented via the <a class="el" href="structah__http__client__cbs.html#a89d3133a1c1130ae7023e1fabbcc9bb1" title="cln has been closed.">ah_http_client_cbs::on_close</a> callback of <em>cln</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following error codes: <ul>
<li>
<a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a> - Close of <em>cln</em> successfully scheduled. </li>
<li>
<a class="el" href="err_8h.html#aadafdf4cd97c6a55df7d8b3eb5a9ab05">AH_EINVAL</a> - <em>cln</em> is <code>NULL</code>. </li>
<li>
<a class="el" href="err_8h.html#aa95f2476779b43aa0fb7b8dce7092e70">AH_ESTATE</a> - <em>cln</em> is already closed. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a2b95d0ccdc86388438d99fdfc65d45e2" name="a2b95d0ccdc86388438d99fdfc65d45e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b95d0ccdc86388438d99fdfc65d45e2">◆ </a></span>ah_http_client_connect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> ah_http_client_connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="unionah__sockaddr.html">ah_sockaddr_t</a> * </td>
<td class="paramname"><em>raddr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Schedules connection of <em>cln</em>, which must be open, to <em>raddr</em>. </p>
<p >If the return value of this function is <a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a>, meaning that connection could indeed be scheduled, its result will eventually be presented via the <a class="el" href="structah__http__client__cbs.html#ab7d4ae298f4368e38183e97d5c855254" title="cln has been connected to a specified remote host, or the attempt to connect it has failed.">ah_http_client_cbs::on_connect</a> callback of <em>cln</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>
<tr><td class="paramname">raddr</td><td>Pointer to socket address representing the remote host to which the cln connection is to be established. If connection is successful, the referenced address must remain valid until <em>cln</em> is closed. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following error codes: <ul>
<li>
<a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a> - <em>cln</em> opening successfully scheduled. </li>
<li>
<a class="el" href="err_8h.html#aa0a6cc5ca923aaddc452f4f0daccbf60">AH_EAFNOSUPPORT</a> - <em>raddr</em> is not an IP-based address. </li>
<li>
<a class="el" href="err_8h.html#a48e584f2f1aa328bd3eee0757611d609">AH_ECANCELED</a> - The event loop of <em>cln</em> is shutting down. </li>
<li>
<a class="el" href="err_8h.html#aadafdf4cd97c6a55df7d8b3eb5a9ab05">AH_EINVAL</a> - <em>cln</em> or <em>raddr</em> is <code>NULL</code>. </li>
<li>
<a class="el" href="err_8h.html#aae90908ac56245681663381edb2eda2a">AH_ENOBUFS</a> - Not enough buffer space available. </li>
<li>
<a class="el" href="err_8h.html#a93152c7ed33b050e5269c18301108a94">AH_ENOMEM</a> - Not enough heap memory available. </li>
<li>
<a class="el" href="err_8h.html#aa95f2476779b43aa0fb7b8dce7092e70">AH_ESTATE</a> - <em>cln</em> is not open. </li>
</ul>
</dd></dl>
<dl class="section pre"><dt>Precondition</dt><dd>This function must be called with a successfully opened cln. An appropriate place to call this function is often going to be in an <a class="el" href="structah__http__client__cbs.html#a063349ed990a73f70950b6bab686a953" title="cln has been opened, or the attempt failed.">ah_http_client_cbs::on_open</a> callback after a check that opening was successful. </dd></dl>
</div>
</div>
<a id="a0459cfe2bd9f389b7ce586a8a3dcea3e" name="a0459cfe2bd9f389b7ce586a8a3dcea3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0459cfe2bd9f389b7ce586a8a3dcea3e">◆ </a></span>ah_http_client_get_conn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="structah__tcp__conn.html">ah_tcp_conn_t</a> * ah_http_client_get_conn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the TCP connection of <em>cln</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to TCP connection of <em>cln</em>, or <code>NULL</code> if <em>cln</em> is <code>NULL</code>.</dd></dl>
<dl class="section note"><dt>Note</dt><dd><em>cln</em> notably shares <em>user data pointer</em> and <em>receive buffer</em> with the TCP connection returned by this function. If you change or update the user data or detach the receive buffer via either <em>cln</em> or the connection, both are affected. </dd></dl>
</div>
</div>
<a id="a1b622e70c0e84c971414994077bbed95" name="a1b622e70c0e84c971414994077bbed95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b622e70c0e84c971414994077bbed95">◆ </a></span>ah_http_client_get_laddr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> ah_http_client_get_laddr </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="unionah__sockaddr.html">ah_sockaddr_t</a> * </td>
<td class="paramname"><em>laddr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stores local address bound by <em>cln</em> into <em>laddr</em>. </p>
<p >If <em>cln</em> was opened with a zero port, this function will report what concrete port was assigned to <em>cln</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>
<tr><td class="paramname">laddr</td><td>Pointer to socket address to be set by this operation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following error codes: <ul>
<li>
<a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a> - The operation was successful. </li>
<li>
<a class="el" href="err_8h.html#aadafdf4cd97c6a55df7d8b3eb5a9ab05">AH_EINVAL</a> - <em>cln</em> or <em>laddr</em> is <code>NULL</code>. </li>
<li>
<a class="el" href="err_8h.html#aeeaaf58314a341082726c379fc63c2a3">AH_ENETDOWN</a> [Win32] - The network subsystem has failed. </li>
<li>
<a class="el" href="err_8h.html#aae90908ac56245681663381edb2eda2a">AH_ENOBUFS</a> [Darwin, Linux] - Not enough buffer space available. </li>
<li>
<a class="el" href="err_8h.html#aa95f2476779b43aa0fb7b8dce7092e70">AH_ESTATE</a> - <em>cln</em> is closed. </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function will always report the same local address as the TCP connection of <em>cln</em> would have reported if <a class="el" href="tcp_8h.html#aed8ee7942f803821ad3dc5b5d8c43e07" title="Stores local address bound by conn into laddr.">ah_tcp_conn_get_laddr()</a> was called. You can get a pointer to that TCP connection by calling <a class="el" href="http_8h.html#a0459cfe2bd9f389b7ce586a8a3dcea3e" title="Gets the TCP connection of cln.">ah_http_client_get_conn()</a> with <em>cln</em> as argument. </dd></dl>
</div>
</div>
<a id="a2ecd3e6fb122fcd92d181b0f31f7e931" name="a2ecd3e6fb122fcd92d181b0f31f7e931"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ecd3e6fb122fcd92d181b0f31f7e931">◆ </a></span>ah_http_client_get_loop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="structah__loop.html">ah_loop_t</a> * ah_http_client_get_loop </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets pointer to event loop of <em>cln</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to event loop, or <code>NULL</code> if <em>cln</em> is <code>NULL</code>.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function gets the event loop pointer of the <a class="el" href="structah__tcp__conn.html" title="TCP connection handle.">ah_tcp_conn</a> owned by <em>cln</em>. You can get a pointer to that TCP connection by calling <a class="el" href="http_8h.html#a0459cfe2bd9f389b7ce586a8a3dcea3e" title="Gets the TCP connection of cln.">ah_http_client_get_conn()</a> with <em>cln</em> as argument. </dd></dl>
</div>
</div>
<a id="a0a4114087cf499bd5ebc44a4b555c261" name="a0a4114087cf499bd5ebc44a4b555c261"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a4114087cf499bd5ebc44a4b555c261">◆ </a></span>ah_http_client_get_obs_ctx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> void * ah_http_client_get_obs_ctx </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the context pointer of the client observer associated with <em>srv</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to client. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Context pointer, or <code>NULL</code> if <em>cln</em> is <code>NULL</code> or the transport of <em>cln</em> is missing a required function in its virtual function table. Also returns <code>NULL</code> if the context pointer itself is <code>NULL</code>. </dd></dl>
</div>
</div>
<a id="a816bbf2d1973884cb3a8787e219eaf35" name="a816bbf2d1973884cb3a8787e219eaf35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a816bbf2d1973884cb3a8787e219eaf35">◆ </a></span>ah_http_client_get_raddr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> ah_http_client_get_raddr </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="unionah__sockaddr.html">ah_sockaddr_t</a> * </td>
<td class="paramname"><em>raddr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stores remote address of <em>cln</em> into <em>raddr</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>
<tr><td class="paramname">raddr</td><td>Pointer to socket address to be set by this operation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following error codes: <ul>
<li>
<a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a> - The operation was successful. </li>
<li>
<a class="el" href="err_8h.html#aadafdf4cd97c6a55df7d8b3eb5a9ab05">AH_EINVAL</a> - <em>cln</em> or <em>raddr</em> is <code>NULL</code>. </li>
<li>
<a class="el" href="err_8h.html#aeeaaf58314a341082726c379fc63c2a3">AH_ENETDOWN</a> [Win32] - The network subsystem has failed. </li>
<li>
<a class="el" href="err_8h.html#aae90908ac56245681663381edb2eda2a">AH_ENOBUFS</a> [Darwin, Linux] - Not enough buffer space available. </li>
<li>
<a class="el" href="err_8h.html#aa95f2476779b43aa0fb7b8dce7092e70">AH_ESTATE</a> - <em>cln</em> is not connected to a remote host. </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function will always report the same local address as the TCP connection of <em>cln</em> would have reported if <a class="el" href="tcp_8h.html#ab9e216e580af9321b62cd3575b899fe8" title="Stores remote address of conn into raddr.">ah_tcp_conn_get_raddr()</a> was called. You can get a pointer to that TCP connection by calling <a class="el" href="http_8h.html#a0459cfe2bd9f389b7ce586a8a3dcea3e" title="Gets the TCP connection of cln.">ah_http_client_get_conn()</a> with <em>cln</em> as argument. </dd></dl>
</div>
</div>
<a id="aba6230b627c5522ff6e9c8cf3e13feb7" name="aba6230b627c5522ff6e9c8cf3e13feb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba6230b627c5522ff6e9c8cf3e13feb7">◆ </a></span>ah_http_client_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> ah_http_client_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structah__loop.html">ah_loop_t</a> * </td>
<td class="paramname"><em>loop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structah__tcp__trans.html">ah_tcp_trans_t</a> </td>
<td class="paramname"><em>trans</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structah__http__client__obs.html">ah_http_client_obs_t</a> </td>
<td class="paramname"><em>obs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes <em>cln</em> for subsequent use. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>
<tr><td class="paramname">loop</td><td>Pointer to event loop. </td></tr>
<tr><td class="paramname">trans</td><td>Desired transport. </td></tr>
<tr><td class="paramname">obs</td><td>Pointer to cln event observer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following error codes: <ul>
<li>
<a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a> - <em>cln</em> successfully initialized. </li>
<li>
<a class="el" href="err_8h.html#aadafdf4cd97c6a55df7d8b3eb5a9ab05">AH_EINVAL</a> - <em>cln</em> or <em>loop</em> or <em>cbs</em> is <code>NULL</code>. </li>
<li>
<a class="el" href="err_8h.html#aadafdf4cd97c6a55df7d8b3eb5a9ab05">AH_EINVAL</a> - <em>trans</em> <code>vtab</code> is invalid, as reported by <a class="el" href="tcp_8h.html#a6b113620283c060df4fe657c20abebbf" title="Checks if every field of vtab is set, making it valid for use as part of a TCP transport.">ah_tcp_trans_vtab_is_valid()</a>. </li>
<li>
<a class="el" href="err_8h.html#aadafdf4cd97c6a55df7d8b3eb5a9ab05">AH_EINVAL</a> - <code>on_open</code>, <code>on_connect</code>, <code>on_send</code>, <code>on_recv_line</code>, <code>on_recv_header</code>, <code>on_recv_data</code>, <code>on_recv_end</code>, or <code>on_close</code> of <em>cbs</em> is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a3407248cc10199c91877397d823f6c37" name="a3407248cc10199c91877397d823f6c37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3407248cc10199c91877397d823f6c37">◆ </a></span>ah_http_client_open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> ah_http_client_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="unionah__sockaddr.html">ah_sockaddr_t</a> * </td>
<td class="paramname"><em>laddr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Schedules opening of <em>cln</em>, which must be initialized, and its binding to the local network interface represented by <em>laddr</em>. </p>
<p >If the return value of this function is <a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a>, meaning that the open attempt could indeed be scheduled, its result will eventually be presented via the <a class="el" href="structah__http__client__cbs.html#a063349ed990a73f70950b6bab686a953" title="cln has been opened, or the attempt failed.">ah_http_client_cbs::on_open</a> callback of <em>cln</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>
<tr><td class="paramname">laddr</td><td>Pointer to socket address representing a local network interface through which the cln connection must later be established. If opening is successful, the referenced address must remain valid for the entire lifetime of the created cln. To bind to all or any local network interface, provide the wildcard address (see ah_sockaddr_ipv4_wildcard and ah_sockaddr_ipv6_wildcard). If you want the platform to chose port number automatically, specify port <code>0</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following error codes: <ul>
<li>
<a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a> - <em>cln</em> opening successfully scheduled. </li>
<li>
<a class="el" href="err_8h.html#aa0a6cc5ca923aaddc452f4f0daccbf60">AH_EAFNOSUPPORT</a> - <em>laddr</em> is not <code>NULL</code> and is not an IP-based address. </li>
<li>
<a class="el" href="err_8h.html#a48e584f2f1aa328bd3eee0757611d609">AH_ECANCELED</a> - The event loop of <em>cln</em> is shutting down. </li>
<li>
<a class="el" href="err_8h.html#aadafdf4cd97c6a55df7d8b3eb5a9ab05">AH_EINVAL</a> - <em>cln</em> is <code>NULL</code>. </li>
<li>
<a class="el" href="err_8h.html#aae90908ac56245681663381edb2eda2a">AH_ENOBUFS</a> - Not enough buffer space available. </li>
<li>
<a class="el" href="err_8h.html#a93152c7ed33b050e5269c18301108a94">AH_ENOMEM</a> - Not enough heap memory available. </li>
<li>
<a class="el" href="err_8h.html#aa95f2476779b43aa0fb7b8dce7092e70">AH_ESTATE</a> - <em>cln</em> is not closed. </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Every successfully opened <em>cln</em> must eventually be provided to <a class="el" href="http_8h.html#a4a0cacd784a5c0c3dc2b0af93745d02a" title="Schedules closing of cln.">ah_http_client_close()</a>. </dd></dl>
</div>
</div>
<a id="a95ac1840f6f2b2ae9d8a0b32e1366d79" name="a95ac1840f6f2b2ae9d8a0b32e1366d79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95ac1840f6f2b2ae9d8a0b32e1366d79">◆ </a></span>ah_http_client_send_chunk()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> ah_http_client_send_chunk </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structah__http__chunk.html">ah_http_chunk_t</a> * </td>
<td class="paramname"><em>chunk</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Schedules sending of HTTP message body data in the form of a <em>chunk</em>. </p>
<p >This function is used to continue a send procedure initiated for <em>cln</em> via a call to <a class="el" href="http_8h.html#afdfe56387101bf4b1bb954f002fa3ef2" title="Schedules sending of HTTP message head.">ah_http_client_send_head()</a>. It is meant to be used when no <code>Content-Length</code> header is specified in the head. Concretely, it schedules the sending of <em>chunk</em>, which is sent asynchronously as soon as the underlying TCP transport is able to. You may call this function with the same <em>cln</em> as many times as you want before ending the sending procedure by providing <em>cln</em> to <a class="el" href="http_8h.html#aef012c485382dc1051919809f266021e" title="Schedules sending of last chunk and trailer of and ends the current message of cln.">ah_http_client_send_trailer()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>
<tr><td class="paramname">chunk</td><td>Pointer to chunk. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following error codes: <ul>
<li>
<a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a> - Transmission of <em>out</em> enqueued successfully. </li>
<li>
<a class="el" href="err_8h.html#a48e584f2f1aa328bd3eee0757611d609">AH_ECANCELED</a> - The event loop of <em>cln</em> is shutting down. </li>
<li>
<a class="el" href="err_8h.html#a7cf5011c680a591df888f256f0881dbd">AH_ESYNTAX</a> - The <code>ext</code> field of <em>chunk</em> is not <code>NULL</code>, an empty NULL-terminated C string and it does not begin with a semicolon <code></code>;, which means that inserting <code>ext</code> into the chunk will make it syntactically invalid. <em>This error code is only returned when running in <code>DEBUG</code> mode.</em> </li>
<li>
<a class="el" href="err_8h.html#aadafdf4cd97c6a55df7d8b3eb5a9ab05">AH_EINVAL</a> - <em>cln</em> or <em>chunk</em> is <code>NULL</code>. </li>
<li>
<a class="el" href="err_8h.html#aeeaaf58314a341082726c379fc63c2a3">AH_ENETDOWN</a> [Win32] - The network subsystem has failed. </li>
<li>
<a class="el" href="err_8h.html#aae90908ac56245681663381edb2eda2a">AH_ENOBUFS</a> - Not enough buffer space available. </li>
<li>
<a class="el" href="err_8h.html#a93152c7ed33b050e5269c18301108a94">AH_ENOMEM</a> - Not enough heap memory available. </li>
<li>
<a class="el" href="err_8h.html#a65a9889d59795edbe23364fd1f8e7752">AH_EOVERFLOW</a> - The used output buffer, which is always allocated via the page allocator (see <a class="el" href="alloc_8h.html#a911d4e66ad39e4007ef01aec5a0ec06a" title="Allocates a page of memory, guaranteed to be at least AH_PSIZE bytes large.">ah_palloc()</a>) is too small for it to be possible to store the <code>size</code> and <code>ext</code> specified in <em>chunk</em>. </li>
<li>
<a class="el" href="err_8h.html#ae0e0879f9ed8201bc7d79d10fd2b3e78">AH_ERANGE</a> - The variable keeping track of the number of currently enqueued data transmissions would overflow if <em>chunk</em> was accepted. </li>
<li>
<a class="el" href="err_8h.html#aa95f2476779b43aa0fb7b8dce7092e70">AH_ESTATE</a> - <em>cln</em> is not currently sending any HTTP message, <em>cln</em> is not open, or the write direction of the connection of <em>cln</em> has been shut down. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a038276fcd4deb032722bc2104c8fdb2b" name="a038276fcd4deb032722bc2104c8fdb2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a038276fcd4deb032722bc2104c8fdb2b">◆ </a></span>ah_http_client_send_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> ah_http_client_send_data </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structah__tcp__out.html">ah_tcp_out_t</a> * </td>
<td class="paramname"><em>out</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Schedules sending of HTTP message body data. </p>
<p >This function is used to continue the send procedure, which must have been initiated for <em>cln</em> via a call to <a class="el" href="http_8h.html#afdfe56387101bf4b1bb954f002fa3ef2" title="Schedules sending of HTTP message head.">ah_http_client_send_head()</a>. It is meant to be used when a <code>Content-Length</code> header is specified in the head with a value larger than zero. The function schedules the transmission of some or all of the data indicated by that <code>Content-Length</code>. You must ensure that exactly <code>Content-Length</code> bytes of body data is sent, via one or more calls to this function, before <a class="el" href="http_8h.html#a684e4861788b51a68e3ed308aa20d6cf" title="Ends current HTTP message of cln.">ah_http_client_send_end()</a> is called with <em>cln</em> to end the message.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>
<tr><td class="paramname">out</td><td>Pointer to TCP output buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following error codes: <ul>
<li>
<a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a> - Transmission of <em>out</em> enqueued successfully. </li>
<li>
<a class="el" href="err_8h.html#a48e584f2f1aa328bd3eee0757611d609">AH_ECANCELED</a> - The event loop of <em>cln</em> is shutting down. </li>
<li>
<a class="el" href="err_8h.html#aadafdf4cd97c6a55df7d8b3eb5a9ab05">AH_EINVAL</a> - <em>cln</em> or <em>out</em> is <code>NULL</code>. </li>
<li>
<a class="el" href="err_8h.html#aeeaaf58314a341082726c379fc63c2a3">AH_ENETDOWN</a> [Win32] - The network subsystem has failed. </li>
<li>
<a class="el" href="err_8h.html#aae90908ac56245681663381edb2eda2a">AH_ENOBUFS</a> - Not enough buffer space available. </li>
<li>
<a class="el" href="err_8h.html#a93152c7ed33b050e5269c18301108a94">AH_ENOMEM</a> - Not enough heap memory available. </li>
<li>
<a class="el" href="err_8h.html#ae0e0879f9ed8201bc7d79d10fd2b3e78">AH_ERANGE</a> - The variable keeping track of the number of currently enqueued data transmissions would overflow if <em>out</em> was accepted. </li>
<li>
<a class="el" href="err_8h.html#aa95f2476779b43aa0fb7b8dce7092e70">AH_ESTATE</a> - <em>cln</em> is not currently sending any HTTP message, <em>cln</em> is not open, or the write direction of the connection of <em>cln</em> has been shut down. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a684e4861788b51a68e3ed308aa20d6cf" name="a684e4861788b51a68e3ed308aa20d6cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a684e4861788b51a68e3ed308aa20d6cf">◆ </a></span>ah_http_client_send_end()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> ah_http_client_send_end </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ends current HTTP message of <em>cln</em>. </p>
<p >Call this function after a successful call to either <a class="el" href="http_8h.html#afdfe56387101bf4b1bb954f002fa3ef2" title="Schedules sending of HTTP message head.">ah_http_client_send_head()</a> or <a class="el" href="http_8h.html#a038276fcd4deb032722bc2104c8fdb2b" title="Schedules sending of HTTP message body data.">ah_http_client_send_data()</a> to indicate that the current message is complete.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following error codes: <ul>
<li>
<a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a> - Transmission of <em>out</em> ended successfully. </li>
<li>
<a class="el" href="err_8h.html#aadafdf4cd97c6a55df7d8b3eb5a9ab05">AH_EINVAL</a> - <em>cln</em> is <code>NULL</code>. </li>
<li>
<a class="el" href="err_8h.html#aa95f2476779b43aa0fb7b8dce7092e70">AH_ESTATE</a> - <em>cln</em> is not currently sending any HTTP message. </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function returning with the error code <a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a>, which indicates success, only means that all parts of the message have been enqueued. Whether or not their actual transmission is successful is reported later via <a class="el" href="structah__http__client__cbs.html#af46cd4ef226ad15bfd77c29035fd4265" title="cln finished sending an HTTP message or the attempt failed.">ah_http_client_cbs::on_send</a>. </dd></dl>
</div>
</div>
<a id="afdfe56387101bf4b1bb954f002fa3ef2" name="afdfe56387101bf4b1bb954f002fa3ef2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdfe56387101bf4b1bb954f002fa3ef2">◆ </a></span>ah_http_client_send_head()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> ah_http_client_send_head </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structah__http__head.html">ah_http_head_t</a> * </td>
<td class="paramname"><em>head</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Schedules sending of HTTP message head. </p>
<p >Calling this function initiates a send procedure by adding <em>head</em> to the send queue of <em>cln</em>. You must finalize that procedure in one out of three ways, outlined in the below table. How depends on if an HTTP body is to be included in the message and, if so, the final size of that body known in advance.</p>
<a class="anchor" id="http-send-procedures"></a>
<table class="doxtable">
<caption>Possible Continuations of the Send Procedure</caption>
<tr>
<th>Prerequisite </th><th>Description </th></tr>
<tr>
<td>No body </td><td>Call <a class="el" href="http_8h.html#a684e4861788b51a68e3ed308aa20d6cf" title="Ends current HTTP message of cln.">ah_http_client_send_end()</a>. </td></tr>
<tr>
<td>Body size known </td><td>Call <a class="el" href="http_8h.html#a038276fcd4deb032722bc2104c8fdb2b" title="Schedules sending of HTTP message body data.">ah_http_client_send_data()</a> until there are no more body parts to send. Finally, call <a class="el" href="http_8h.html#a684e4861788b51a68e3ed308aa20d6cf" title="Ends current HTTP message of cln.">ah_http_client_send_end()</a>. </td></tr>
<tr>
<td>Body size unknown </td><td>Call <a class="el" href="http_8h.html#a95ac1840f6f2b2ae9d8a0b32e1366d79" title="Schedules sending of HTTP message body data in the form of a chunk.">ah_http_client_send_chunk()</a> until there are no more body parts to send. Finally, call <a class="el" href="http_8h.html#aef012c485382dc1051919809f266021e" title="Schedules sending of last chunk and trailer of and ends the current message of cln.">ah_http_client_send_trailer()</a>. </td></tr>
</table>
<p >The invocation of this function must be successful in order for it to be possible to follow any of the above procedures. Please refer to the documentation for the functions in the above table for further details.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>
<tr><td class="paramname">head</td><td>Pointer to head, specifying a start line and set of headers. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following error codes: <ul>
<li>
<a class="el" href="err_8h.html#af1346324d9368d43e1e103d395368306">AH_ENONE</a> - Transmission of <em>head</em> enqueued successfully. </li>
<li>
<a class="el" href="err_8h.html#aadafdf4cd97c6a55df7d8b3eb5a9ab05">AH_EINVAL</a> - <em>cln</em> or <em>head</em> is <code>NULL</code>. </li>
<li>
<a class="el" href="err_8h.html#acd76fd87a340e2584e6971bba20b57e2">AH_EPROTONOSUPPORT</a> - The HTTP version specified in <code>head->version</code> is not supported. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="aef012c485382dc1051919809f266021e" name="aef012c485382dc1051919809f266021e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef012c485382dc1051919809f266021e">◆ </a></span>ah_http_client_send_trailer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defs_8h.html#a4a00eaa653b79c27bff40d48d658f86f">ah_extern</a> <a class="el" href="defs_8h.html#a746483e29fbbad8cb71e1b3875763ae2">ah_err_t</a> ah_http_client_send_trailer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structah__http__client.html">ah_http_client_t</a> * </td>
<td class="paramname"><em>cln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structah__http__trailer.html">ah_http_trailer_t</a> * </td>
<td class="paramname"><em>trailer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Schedules sending of last chunk and trailer of and ends the current message of <em>cln</em>. </p>
<p >Call this function after a successful call to either <a class="el" href="http_8h.html#afdfe56387101bf4b1bb954f002fa3ef2" title="Schedules sending of HTTP message head.">ah_http_client_send_head()</a> or <a class="el" href="http_8h.html#a95ac1840f6f2b2ae9d8a0b32e1366d79" title="Schedules sending of HTTP message body data in the form of a chunk.">ah_http_client_send_chunk()</a> to send the last chunk and trailer, as well as to indicate that the current message is complete.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cln</td><td>Pointer to cln. </td></tr>