/usr/share/gtk-doc/html/raptor/raptor-section-www.html is in libraptor1-doc 1.4.21-10.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WWW</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Raptor RDF Syntax Parsing and Serializing Library Manual">
<link rel="up" href="reference-manual.html" title="Part II. Raptor Reference Manual">
<link rel="prev" href="raptor-section-uri.html" title="URI">
<link rel="next" href="raptor-section-xml-namespace.html" title="XML Namespaces">
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="introduction.html" title="Raptor Overview">
<link rel="part" href="tutorial.html" title="Part I. Raptor Tutorial">
<link rel="chapter" href="tutorial-initialising-finishing.html" title="Initialising and Finishing using the Library">
<link rel="chapter" href="tutorial-querying-functionality.html" title="Listing built-in functionality">
<link rel="chapter" href="tutorial-parsing.html" title="Parsing syntaxes to RDF Triples">
<link rel="chapter" href="tutorial-serializing.html" title="Serializing RDF triples to a syntax">
<link rel="part" href="reference-manual.html" title="Part II. Raptor Reference Manual">
<link rel="chapter" href="raptor-parsers.html" title="Parsers in Raptor (syntax to triples)">
<link rel="chapter" href="raptor-serializers.html" title="Serializers in Raptor (triples to syntax)">
<link rel="index" href="ix01.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="raptor-section-uri.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="reference-manual.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Raptor RDF Syntax Parsing and Serializing Library Manual</th>
<td><a accesskey="n" href="raptor-section-xml-namespace.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#raptor-section-www.synopsis" class="shortcut">Top</a>
|
<a href="#raptor-section-www.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="WWW">
<a name="raptor-section-www"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="raptor-section-www.top_of_page"></a>WWW</span></h2>
<p>WWW — Retrieval of URI content from the web.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="raptor-section-www.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">typedef <a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www">raptor_www</a>;
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-init" title="raptor_www_init ()">raptor_www_init</a> (void);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-finish" title="raptor_www_finish ()">raptor_www_finish</a> (void);
<span class="returnvalue">void</span> (<a class="link" href="raptor-section-www.html#raptor-www-write-bytes-handler" title="raptor_www_write_bytes_handler ()">*raptor_www_write_bytes_handler</a>) (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<span class="returnvalue">void</span> *userdata,
const <span class="returnvalue">void</span> *ptr,
<span class="returnvalue">size_t</span> size,
<span class="returnvalue">size_t</span> nmemb);
<span class="returnvalue">void</span> (<a class="link" href="raptor-section-www.html#raptor-www-content-type-handler" title="raptor_www_content_type_handler ()">*raptor_www_content_type_handler</a>) (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<span class="returnvalue">void</span> *userdata,
const <span class="returnvalue">char</span> *content_type);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-no-www-library-init-finish" title="raptor_www_no_www_library_init_finish ()">raptor_www_no_www_library_init_finish</a>
(void);
<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> * <a class="link" href="raptor-section-www.html#raptor-www-new" title="raptor_www_new ()">raptor_www_new</a> (void);
<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> * <a class="link" href="raptor-section-www.html#raptor-www-new-with-connection" title="raptor_www_new_with_connection ()">raptor_www_new_with_connection</a> (<span class="returnvalue">void</span> *connection);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-free" title="raptor_www_free ()">raptor_www_free</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-set-user-agent" title="raptor_www_set_user_agent ()">raptor_www_set_user_agent</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
const <span class="returnvalue">char</span> *user_agent);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-set-proxy" title="raptor_www_set_proxy ()">raptor_www_set_proxy</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
const <span class="returnvalue">char</span> *proxy);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-set-http-accept" title="raptor_www_set_http_accept ()">raptor_www_set_http_accept</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
const <span class="returnvalue">char</span> *value);
<span class="returnvalue">int</span> <a class="link" href="raptor-section-www.html#raptor-www-set-http-cache-control" title="raptor_www_set_http_cache_control ()">raptor_www_set_http_cache_control</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
const <span class="returnvalue">char</span> *cache_control);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-set-write-bytes-handler" title="raptor_www_set_write_bytes_handler ()">raptor_www_set_write_bytes_handler</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-www.html#raptor-www-write-bytes-handler" title="raptor_www_write_bytes_handler ()"><span class="returnvalue">raptor_www_write_bytes_handler</span></a> handler,
<span class="returnvalue">void</span> *user_data);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-set-connection-timeout" title="raptor_www_set_connection_timeout ()">raptor_www_set_connection_timeout</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<span class="returnvalue">int</span> timeout);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-set-content-type-handler" title="raptor_www_set_content_type_handler ()">raptor_www_set_content_type_handler</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-www.html#raptor-www-content-type-handler" title="raptor_www_content_type_handler ()"><span class="returnvalue">raptor_www_content_type_handler</span></a> handler,
<span class="returnvalue">void</span> *user_data);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-set-error-handler" title="raptor_www_set_error_handler ()">raptor_www_set_error_handler</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-general.html#raptor-message-handler" title="raptor_message_handler ()"><span class="returnvalue">raptor_message_handler</span></a> error_handler,
<span class="returnvalue">void</span> *error_data);
<span class="returnvalue">int</span> (<a class="link" href="raptor-section-www.html#raptor-uri-filter-func" title="raptor_uri_filter_func ()">*raptor_uri_filter_func</a>) (<span class="returnvalue">void</span> *user_data,
<a class="link" href="raptor-section-uri.html#raptor-uri" title="raptor_uri"><span class="returnvalue">raptor_uri</span></a> *uri);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-set-uri-filter" title="raptor_www_set_uri_filter ()">raptor_www_set_uri_filter</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-www.html#raptor-uri-filter-func" title="raptor_uri_filter_func ()"><span class="returnvalue">raptor_uri_filter_func</span></a> filter,
<span class="returnvalue">void</span> *user_data);
<span class="returnvalue">void</span> (<a class="link" href="raptor-section-www.html#raptor-www-final-uri-handler" title="raptor_www_final_uri_handler ()">*raptor_www_final_uri_handler</a>) (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<span class="returnvalue">void</span> *userdata,
<a class="link" href="raptor-section-uri.html#raptor-uri" title="raptor_uri"><span class="returnvalue">raptor_uri</span></a> *final_uri);
<a class="link" href="raptor-section-uri.html#raptor-uri" title="raptor_uri"><span class="returnvalue">raptor_uri</span></a>* <a class="link" href="raptor-section-www.html#raptor-www-get-final-uri" title="raptor_www_get_final_uri ()">raptor_www_get_final_uri</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-set-final-uri-handler" title="raptor_www_set_final_uri_handler ()">raptor_www_set_final_uri_handler</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-www.html#raptor-www-final-uri-handler" title="raptor_www_final_uri_handler ()"><span class="returnvalue">raptor_www_final_uri_handler</span></a> handler,
<span class="returnvalue">void</span> *user_data);
<span class="returnvalue">int</span> <a class="link" href="raptor-section-www.html#raptor-www-fetch" title="raptor_www_fetch ()">raptor_www_fetch</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-uri.html#raptor-uri" title="raptor_uri"><span class="returnvalue">raptor_uri</span></a> *uri);
<span class="returnvalue">int</span> <a class="link" href="raptor-section-www.html#raptor-www-fetch-to-string" title="raptor_www_fetch_to_string ()">raptor_www_fetch_to_string</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-uri.html#raptor-uri" title="raptor_uri"><span class="returnvalue">raptor_uri</span></a> *uri,
<span class="returnvalue">void</span> **string_p,
<span class="returnvalue">size_t</span> *length_p,
<span class="returnvalue">void</span>* (malloc_handlersize_t size) ());
<span class="returnvalue">void</span>* <a class="link" href="raptor-section-www.html#raptor-www-get-connection" title="raptor_www_get_connection ()">raptor_www_get_connection</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www);
<span class="returnvalue">void</span> <a class="link" href="raptor-section-www.html#raptor-www-abort" title="raptor_www_abort ()">raptor_www_abort</a> (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
const <span class="returnvalue">char</span> *reason);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="raptor-section-www.description"></a><h2>Description</h2>
<p>
Provides a wrapper to the resolution of URIs to give content
using an underlying WWW-retrieval library. The content is
delivered by callbacks and includes returning content type
for handling content-negotation by the caller as well as
chunks of byte content.
</p>
</div>
<div class="refsect1" title="Details">
<a name="raptor-section-www.details"></a><h2>Details</h2>
<div class="refsect2" title="raptor_www">
<a name="raptor-www"></a><h3>raptor_www</h3>
<pre class="programlisting">raptor_www* raptor_www;
</pre>
<p>
Raptor WWW class</p>
</div>
<hr>
<div class="refsect2" title="raptor_www_init ()">
<a name="raptor-www-init"></a><h3>raptor_www_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_init (void);</pre>
<p>
Initialise the WWW class.
</p>
<p>
Must be called before creating any <a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="type">raptor_www</span></a> object.
</p>
<p>
See also: <code class="function">raptor_www_init_v2()</code></p>
</div>
<hr>
<div class="refsect2" title="raptor_www_finish ()">
<a name="raptor-www-finish"></a><h3>raptor_www_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_finish (void);</pre>
<p>
Terminate the WWW class.
</p>
<p>
Must be called to clean any resources used by the WWW implementation.
</p>
<p>
See also: <code class="function">raptor_www_finish_v2()</code></p>
</div>
<hr>
<div class="refsect2" title="raptor_www_write_bytes_handler ()">
<a name="raptor-www-write-bytes-handler"></a><h3>raptor_www_write_bytes_handler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*raptor_www_write_bytes_handler) (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<span class="returnvalue">void</span> *userdata,
const <span class="returnvalue">void</span> *ptr,
<span class="returnvalue">size_t</span> size,
<span class="returnvalue">size_t</span> nmemb);</pre>
<p>
Receiving bytes of data from WWW retrieval handler.
</p>
<p>
Set by <a class="link" href="raptor-section-www.html#raptor-www-set-write-bytes-handler" title="raptor_www_set_write_bytes_handler ()"><code class="function">raptor_www_set_write_bytes_handler()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
<td> user data
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ptr</code></em> :</span></p></td>
<td> data pointer
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td> size of individual item
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nmemb</code></em> :</span></p></td>
<td> number of items
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_content_type_handler ()">
<a name="raptor-www-content-type-handler"></a><h3>raptor_www_content_type_handler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*raptor_www_content_type_handler) (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<span class="returnvalue">void</span> *userdata,
const <span class="returnvalue">char</span> *content_type);</pre>
<p>
Receiving Content-Type: header from WWW retrieval handler.
</p>
<p>
Set by <a class="link" href="raptor-section-www.html#raptor-www-set-content-type-handler" title="raptor_www_set_content_type_handler ()"><code class="function">raptor_www_set_content_type_handler()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
<td> user data
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>content_type</code></em> :</span></p></td>
<td> content type seen
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_no_www_library_init_finish ()">
<a name="raptor-www-no-www-library-init-finish"></a><h3>raptor_www_no_www_library_init_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_no_www_library_init_finish
(void);</pre>
<p>
Do not initialise or finish the lower level WWW library.
</p>
<p>
If this is called then the raptor_www library will neither
initialise or terminate the lower level WWW library. Usually in
raptor_init either curl_global_init (for libcurl)
are called and in raptor_finish curl_global_cleanup is called.
</p>
<p>
This allows the application finer control over these libraries such
as setting other global options or potentially calling and terminating
raptor several times. It does mean that applications which use
this call must do their own extra work in order to allocate and free
all resources to the system.
</p>
<p>
This function must be called before raptor_init.
</p>
<p>
See also: <code class="function">raptor_www_no_www_library_init_finish_v2()</code></p>
</div>
<hr>
<div class="refsect2" title="raptor_www_new ()">
<a name="raptor-www-new"></a><h3>raptor_www_new ()</h3>
<pre class="programlisting"><a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> * raptor_www_new (void);</pre>
<p>
Constructor - create a new <a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="type">raptor_www</span></a> object.
</p>
<p>
<a class="link" href="raptor-section-world.html#raptor-init" title="raptor_init ()"><code class="function">raptor_init()</code></a> MUST have been called before calling this function.
Use <code class="function">raptor_www_new_v2()</code> if using raptor_world APIs.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="type">raptor_www</span></a> or NULL on failure.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_new_with_connection ()">
<a name="raptor-www-new-with-connection"></a><h3>raptor_www_new_with_connection ()</h3>
<pre class="programlisting"><a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> * raptor_www_new_with_connection (<span class="returnvalue">void</span> *connection);</pre>
<p>
Constructor - create a new <a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="type">raptor_www</span></a> object over an existing WWW connection.
</p>
<p>
At present this only works with a libcurl CURL handle object
when raptor is compiled with libcurl suppport. Otherwise the
<em class="parameter"><code>connection</code></em> is ignored. This allows such things as setting
up special flags on the curl handle before passing into the constructor.
</p>
<p>
<a class="link" href="raptor-section-world.html#raptor-init" title="raptor_init ()"><code class="function">raptor_init()</code></a> MUST have been called before calling this function.
Use <code class="function">raptor_www_new_with_connection_v2()</code> if using raptor_world APIs.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td> external WWW connection object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="type">raptor_www</span></a> object or NULL on failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_free ()">
<a name="raptor-www-free"></a><h3>raptor_www_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_free (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www);</pre>
<p>
Destructor - destroy a <a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="type">raptor_www</span></a> object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_set_user_agent ()">
<a name="raptor-www-set-user-agent"></a><h3>raptor_www_set_user_agent ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_set_user_agent (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
const <span class="returnvalue">char</span> *user_agent);</pre>
<p>
Set the user agent value, for HTTP requests typically.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_agent</code></em> :</span></p></td>
<td> User-Agent string
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_set_proxy ()">
<a name="raptor-www-set-proxy"></a><h3>raptor_www_set_proxy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_set_proxy (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
const <span class="returnvalue">char</span> *proxy);</pre>
<p>
Set the proxy for the WWW object.
</p>
<p>
The <em class="parameter"><code>proxy</code></em> usually a string of the form http://server.domain:port.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
<td> proxy string.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_set_http_accept ()">
<a name="raptor-www-set-http-accept"></a><h3>raptor_www_set_http_accept ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_set_http_accept (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
const <span class="returnvalue">char</span> *value);</pre>
<p>
Set HTTP Accept header.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> <a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="type">raptor_www</span></a> class
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td> Accept: header value or NULL to have an empty one.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_set_http_cache_control ()">
<a name="raptor-www-set-http-cache-control"></a><h3>raptor_www_set_http_cache_control ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> raptor_www_set_http_cache_control (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
const <span class="returnvalue">char</span> *cache_control);</pre>
<p>
Set HTTP Cache-Control:header (default none)
</p>
<p>
The <em class="parameter"><code>cache_control</code></em> value can be a string to set it, "" to send
a blank header or NULL to not set the header at all.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cache_control</code></em> :</span></p></td>
<td> Cache-Control header value (or NULL to disable)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_set_write_bytes_handler ()">
<a name="raptor-www-set-write-bytes-handler"></a><h3>raptor_www_set_write_bytes_handler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_set_write_bytes_handler (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-www.html#raptor-www-write-bytes-handler" title="raptor_www_write_bytes_handler ()"><span class="returnvalue">raptor_www_write_bytes_handler</span></a> handler,
<span class="returnvalue">void</span> *user_data);</pre>
<p>
Set the handler to receive bytes written by the <a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="type">raptor_www</span></a> implementation.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>handler</code></em> :</span></p></td>
<td> bytes handler function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td> bytes handler data
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_set_connection_timeout ()">
<a name="raptor-www-set-connection-timeout"></a><h3>raptor_www_set_connection_timeout ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_set_connection_timeout (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<span class="returnvalue">int</span> timeout);</pre>
<p>
Set WWW connection timeout</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timeout</code></em> :</span></p></td>
<td> Timeout in seconds
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_set_content_type_handler ()">
<a name="raptor-www-set-content-type-handler"></a><h3>raptor_www_set_content_type_handler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_set_content_type_handler (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-www.html#raptor-www-content-type-handler" title="raptor_www_content_type_handler ()"><span class="returnvalue">raptor_www_content_type_handler</span></a> handler,
<span class="returnvalue">void</span> *user_data);</pre>
<p>
Set the handler to receive the HTTP Content-Type header value.
</p>
<p>
This is called if or when the value is discovered during retrieval
by the raptor_www implementation. Not all implementations provide
access to this.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>handler</code></em> :</span></p></td>
<td> content type handler function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td> content type handler data
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_set_error_handler ()">
<a name="raptor-www-set-error-handler"></a><h3>raptor_www_set_error_handler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_set_error_handler (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-general.html#raptor-message-handler" title="raptor_message_handler ()"><span class="returnvalue">raptor_message_handler</span></a> error_handler,
<span class="returnvalue">void</span> *error_data);</pre>
<p>
Set the error handler routine for the raptor_www class.
</p>
<p>
This takes the same arguments as the <code class="function">raptor_parser_set_error()</code> and
<code class="function">raptor_parser_set_warning_handler()</code> methods.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error_handler</code></em> :</span></p></td>
<td> error handler function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error_data</code></em> :</span></p></td>
<td> error handler data
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_uri_filter_func ()">
<a name="raptor-uri-filter-func"></a><h3>raptor_uri_filter_func ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> (*raptor_uri_filter_func) (<span class="returnvalue">void</span> *user_data,
<a class="link" href="raptor-section-uri.html#raptor-uri" title="raptor_uri"><span class="returnvalue">raptor_uri</span></a> *uri);</pre>
<p>
Callback function for <a class="link" href="raptor-section-www.html#raptor-www-set-uri-filter" title="raptor_www_set_uri_filter ()"><span class="type">raptor_www_set_uri_filter</span></a></p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td> user data
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td> <a class="link" href="raptor-section-uri.html#raptor-uri" title="raptor_uri"><span class="type">raptor_uri</span></a> URI to check
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 to filter the URI
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_set_uri_filter ()">
<a name="raptor-www-set-uri-filter"></a><h3>raptor_www_set_uri_filter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_set_uri_filter (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-www.html#raptor-uri-filter-func" title="raptor_uri_filter_func ()"><span class="returnvalue">raptor_uri_filter_func</span></a> filter,
<span class="returnvalue">void</span> *user_data);</pre>
<p>
Set URI filter function for WWW retrieval.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td> URI filter function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td> User data to pass to filter function
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_final_uri_handler ()">
<a name="raptor-www-final-uri-handler"></a><h3>raptor_www_final_uri_handler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*raptor_www_final_uri_handler) (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<span class="returnvalue">void</span> *userdata,
<a class="link" href="raptor-section-uri.html#raptor-uri" title="raptor_uri"><span class="returnvalue">raptor_uri</span></a> *final_uri);</pre>
<p>
Receiving the final resolved URI from a WWW retrieval
</p>
<p>
Set by <a class="link" href="raptor-section-www.html#raptor-www-set-final-uri-handler" title="raptor_www_set_final_uri_handler ()"><code class="function">raptor_www_set_final_uri_handler()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
<td> user data
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>final_uri</code></em> :</span></p></td>
<td> final URI seen
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_get_final_uri ()">
<a name="raptor-www-get-final-uri"></a><h3>raptor_www_get_final_uri ()</h3>
<pre class="programlisting"><a class="link" href="raptor-section-uri.html#raptor-uri" title="raptor_uri"><span class="returnvalue">raptor_uri</span></a>* raptor_www_get_final_uri (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www);</pre>
<p>
Get the WWW final resolved URI.
</p>
<p>
This returns the URI used after any protocol redirection.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> <a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="type">raptor_www</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new URI or NULL if not known.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_set_final_uri_handler ()">
<a name="raptor-www-set-final-uri-handler"></a><h3>raptor_www_set_final_uri_handler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_set_final_uri_handler (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-www.html#raptor-www-final-uri-handler" title="raptor_www_final_uri_handler ()"><span class="returnvalue">raptor_www_final_uri_handler</span></a> handler,
<span class="returnvalue">void</span> *user_data);</pre>
<p>
Set the handler to receive the HTTP Content-Type header value.
</p>
<p>
This is called if or when the value is discovered during retrieval
by the raptor_www implementation. Not all implementations provide
access to this.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>handler</code></em> :</span></p></td>
<td> content type handler function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td> content type handler data
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_fetch ()">
<a name="raptor-www-fetch"></a><h3>raptor_www_fetch ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> raptor_www_fetch (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-uri.html#raptor-uri" title="raptor_uri"><span class="returnvalue">raptor_uri</span></a> *uri);</pre>
<p>
Start a WWW content retrieval for the given URI, returning data via the write_bytes handler.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td> URI to read from
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 on failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_fetch_to_string ()">
<a name="raptor-www-fetch-to-string"></a><h3>raptor_www_fetch_to_string ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> raptor_www_fetch_to_string (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
<a class="link" href="raptor-section-uri.html#raptor-uri" title="raptor_uri"><span class="returnvalue">raptor_uri</span></a> *uri,
<span class="returnvalue">void</span> **string_p,
<span class="returnvalue">size_t</span> *length_p,
<span class="returnvalue">void</span>* (malloc_handlersize_t size) ());</pre>
<p>
Start a WWW content retrieval for the given URI, returning the data in a new string.
</p>
<p>
If malloc_handler is null, raptor will allocate it using it's
own memory allocator. *string_p is set to NULL on failure (and
*length_p to 0 if length_p is not NULL).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> raptor_www object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td> raptor_uri to retrieve
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string_p</code></em> :</span></p></td>
<td> pointer to location to hold string
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length_p</code></em> :</span></p></td>
<td> pointer to location to hold length of string (or NULL)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>malloc_handler</code></em> :</span></p></td>
<td> pointer to malloc to use to make string (or NULL)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_get_connection ()">
<a name="raptor-www-get-connection"></a><h3>raptor_www_get_connection ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>* raptor_www_get_connection (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www);</pre>
<p>
Get WWW library connection object.
</p>
<p>
Return the internal WWW connection handle. For libcurl, this
returns the CURL handle and for libxml the context. Otherwise
it returns NULL.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> <a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="type">raptor_www</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> connection pointer
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="raptor_www_abort ()">
<a name="raptor-www-abort"></a><h3>raptor_www_abort ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> raptor_www_abort (<a class="link" href="raptor-section-www.html#raptor-www" title="raptor_www"><span class="returnvalue">raptor_www</span></a> *www,
const <span class="returnvalue">char</span> *reason);</pre>
<p>
Abort an ongoing raptor WWW operation and pass back a reason.
</p>
<p>
This is typically used within one of the raptor WWW handlers
when retrieval need no longer continue due to another
processing issue or error.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>www</code></em> :</span></p></td>
<td> WWW object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>reason</code></em> :</span></p></td>
<td> abort reason message
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.13</div>
</body>
</html>
|