/documentation/source/reference/common.rst
ReStructuredText | 1196 lines | 699 code | 497 blank | 0 comment | 0 complexity | 11f68e168d8d443db9ae50a38a7eef00 MD5 | raw file
1*********************** 2The HTTP-COMMON library 3*********************** 4 5.. current-library:: http-common 6.. current-module:: http-common 7 8The HTTP-COMMON module 9====================== 10 11.. constant:: $application-error 12 13.. constant:: $bad-gateway-error 14 15.. constant:: $bad-header-error 16 17.. constant:: $bad-request-error 18 19.. constant:: $conflict-error 20 21.. constant:: $content-length-required-error 22 23.. constant:: $default-cookie-version 24 25.. constant:: $expectation-failed-error 26 27.. constant:: $forbidden-error 28 29.. constant:: $found-redirect 30 31.. constant:: $gateway-timeout-error 32 33.. constant:: $gone-error 34 35.. constant:: $header-too-large-error 36 37.. constant:: $http-version-not-supported-error 38 39.. constant:: $internal-server-error 40 41.. constant:: $method-not-allowed-error 42 43.. constant:: $mime-wild 44 45.. constant:: $moved-permanently-redirect 46 47.. constant:: $moved-temporarily-redirect 48 49.. constant:: $not-acceptable-error 50 51.. constant:: $not-implemented-error 52 53.. constant:: $not-modified-redirect 54 55.. constant:: $payment-required-error 56 57.. constant:: $precondition-failed-error 58 59.. constant:: $proxy-authentication-required-error 60 61.. constant:: $request-entity-too-large-error 62 63.. constant:: $request-timeout-error 64 65.. constant:: $request-uri-too-long-error 66 67.. constant:: $requested-range-not-satisfiable-error 68 69.. constant:: $resource-not-found-error 70 71.. constant:: $see-other-redirect 72 73.. constant:: $service-unavailable-error 74 75.. constant:: $status-accepted 76 77.. constant:: $status-application-error 78 79.. constant:: $status-bad-gateway 80 81.. constant:: $status-bad-request 82 83.. constant:: $status-conflict 84 85.. constant:: $status-continue 86 87.. constant:: $status-created 88 89.. constant:: $status-expectation-failed 90 91.. constant:: $status-forbidden 92 93.. constant:: $status-found 94 95.. constant:: $status-gateway-timeout 96 97.. constant:: $status-gone 98 99.. constant:: $status-http-version-not-supported 100 101.. constant:: $status-internal-server-error 102 103.. constant:: $status-length-required 104 105.. constant:: $status-method-not-allowed 106 107.. constant:: $status-moved-permanently 108 109.. constant:: $status-multiple-choices 110 111.. constant:: $status-no-content 112 113.. constant:: $status-non-authoritative-information 114 115.. constant:: $status-not-acceptable 116 117.. constant:: $status-not-found 118 119.. constant:: $status-not-implemented 120 121.. constant:: $status-not-modified 122 123.. constant:: $status-ok 124 125.. constant:: $status-partial-content 126 127.. constant:: $status-payment-required 128 129.. constant:: $status-precondition-failed 130 131.. constant:: $status-proxy-authentication-required 132 133.. constant:: $status-request-entity-too-large 134 135.. constant:: $status-request-timeout 136 137.. constant:: $status-request-uri-too-long 138 139.. constant:: $status-requested-range-not-satisfiable 140 141.. constant:: $status-reset-content 142 143.. constant:: $status-see-other 144 145.. constant:: $status-service-unavailable 146 147.. constant:: $status-switching-protocols 148 149.. constant:: $status-temporary-redirect 150 151.. constant:: $status-unauthorized 152 153.. constant:: $status-unsupported-media-type 154 155.. constant:: $status-use-proxy 156 157.. constant:: $unauthorized-error 158 159.. constant:: $unsupported-media-type-error 160 161.. constant:: $use-proxy-redirect 162 163.. variable:: *http-common-log* 164 165.. class:: <application-error> 166 167 :superclasses: <http-server-protocol-error> 168 169 170.. class:: <attributes-mixin> 171 :open: 172 173 :superclasses: <object> 174 175 :keyword attributes: 176 177.. class:: <avalue> 178 179 :superclasses: <explicit-key-collection> 180 181 :keyword alist: 182 :keyword value: 183 184.. class:: <bad-gateway-error> 185 186 :superclasses: <http-server-protocol-error> 187 188 189.. class:: <bad-header-error> 190 191 :superclasses: <http-parse-error> 192 193 194.. class:: <bad-request-error> 195 196 :superclasses: <http-parse-error> 197 198 199.. class:: <base-http-request> 200 :open: 201 202 :superclasses: <message-headers-mixin>:http-common-internals 203 204 :keyword content: 205 :keyword method: 206 :keyword raw-url: 207 :keyword url: 208 :keyword version: 209 210.. class:: <base-http-response> 211 :open: 212 213 :superclasses: <message-headers-mixin>:http-common-internals 214 215 :keyword chunked: 216 :keyword code: 217 :keyword reason-phrase: 218 :keyword request: 219 220.. class:: <chunking-input-stream> 221 :open: 222 223 :superclasses: <wrapper-stream>:streams:io 224 225 226.. class:: <conflict-error> 227 228 :superclasses: <http-client-protocol-error> 229 230 231.. class:: <content-length-required-error> 232 233 :superclasses: <http-client-protocol-error> 234 235 236.. class:: <expectation-failed-error> 237 238 :superclasses: <http-client-protocol-error> 239 240 241.. class:: <expiring-mixin> 242 :open: 243 244 :superclasses: <object> 245 246 :keyword duration: 247 248.. class:: <forbidden-error> 249 250 :superclasses: <http-client-protocol-error> 251 252 253.. class:: <found-redirect> 254 255 :superclasses: <http-redirect-condition> 256 257 258.. class:: <gateway-timeout-error> 259 260 :superclasses: <http-server-protocol-error> 261 262 263.. class:: <gone-error> 264 265 :superclasses: <http-client-protocol-error> 266 267 268.. class:: <header-table> 269 270 :superclasses: <table> 271 272 273.. class:: <header-too-large-error> 274 275 :superclasses: <http-client-protocol-error> 276 277 278.. class:: <http-client-protocol-error> 279 280 :superclasses: <http-protocol-condition> 281 282 283.. class:: <http-error> 284 :open: 285 286 :superclasses: <format-string-condition>:dylan-extensions:dylan, <error> 287 288 289.. class:: <http-parse-error> 290 291 :superclasses: <http-client-protocol-error> 292 293 294.. class:: <http-protocol-condition> 295 :open: 296 297 :superclasses: <http-error> 298 299 :keyword code: 300 :keyword headers: 301 302.. class:: <http-redirect-condition> 303 304 :superclasses: <http-protocol-condition> 305 306 307.. class:: <http-server-protocol-error> 308 309 :superclasses: <http-protocol-condition> 310 311 312.. class:: <http-version-not-supported-error> 313 314 :superclasses: <http-server-protocol-error> 315 316 317.. class:: <internal-server-error> 318 319 :superclasses: <http-server-protocol-error> 320 321 322.. class:: <media-type> 323 324 :superclasses: <attributes-mixin>, <mime-type>:mime:mime 325 326 327.. class:: <method-not-allowed-error> 328 329 :superclasses: <http-client-protocol-error> 330 331 332.. class:: <moved-permanently-redirect> 333 334 :superclasses: <http-redirect-condition> 335 336 337.. class:: <moved-temporarily-redirect> 338 339 :superclasses: <http-redirect-condition> 340 341 342.. class:: <not-acceptable-error> 343 344 :superclasses: <http-client-protocol-error> 345 346 347.. class:: <not-implemented-error> 348 349 :superclasses: <http-server-protocol-error> 350 351 352.. class:: <not-modified-redirect> 353 354 :superclasses: <http-redirect-condition> 355 356 357.. class:: <payment-required-error> 358 359 :superclasses: <http-client-protocol-error> 360 361 362.. class:: <precondition-failed-error> 363 364 :superclasses: <http-client-protocol-error> 365 366 367.. class:: <proxy-authentication-required-error> 368 369 :superclasses: <http-client-protocol-error> 370 371 372.. class:: <request-entity-too-large-error> 373 374 :superclasses: <http-client-protocol-error> 375 376 377.. class:: <request-timeout-error> 378 379 :superclasses: <http-client-protocol-error> 380 381 382.. class:: <request-uri-too-long-error> 383 384 :superclasses: <http-client-protocol-error> 385 386 387.. class:: <requested-range-not-satisfiable-error> 388 389 :superclasses: <http-client-protocol-error> 390 391 392.. class:: <resource-not-found-error> 393 394 :superclasses: <http-client-protocol-error> 395 396 397.. class:: <see-other-redirect> 398 399 :superclasses: <http-redirect-condition> 400 401 402.. class:: <service-unavailable-error> 403 404 :superclasses: <http-server-protocol-error> 405 406 407.. class:: <unauthorized-error> 408 409 :superclasses: <http-client-protocol-error> 410 411 412.. class:: <unsupported-media-type-error> 413 414 :superclasses: <http-client-protocol-error> 415 416 417.. class:: <use-proxy-redirect> 418 419 :superclasses: <http-redirect-condition> 420 421 422.. function:: application-error 423 424 :signature: application-error (#key headers header-name header-value message) => (#rest results) 425 426 :parameter #key headers: An instance of ``false-or(<header-table>)``. 427 :parameter #key header-name: An instance of ``false-or(<string>)``. 428 :parameter #key header-value: An instance of ``false-or(<string>)``. 429 :parameter #key message: An instance of ``<object>``. 430 :value #rest results: An instance of ``<object>``. 431 432.. generic-function:: avalue-alist 433 434 :signature: avalue-alist (object) => (#rest results) 435 436 :parameter object: An instance of ``<object>``. 437 :value #rest results: An instance of ``<object>``. 438 439.. generic-function:: avalue-value 440 441 :signature: avalue-value (object) => (#rest results) 442 443 :parameter object: An instance of ``<object>``. 444 :value #rest results: An instance of ``<object>``. 445 446.. function:: bad-gateway-error 447 448 :signature: bad-gateway-error (#key headers header-name header-value) => (#rest results) 449 450 :parameter #key headers: An instance of ``false-or(<header-table>)``. 451 :parameter #key header-name: An instance of ``false-or(<string>)``. 452 :parameter #key header-value: An instance of ``false-or(<string>)``. 453 :value #rest results: An instance of ``<object>``. 454 455.. function:: bad-header-error 456 457 :signature: bad-header-error (#key headers header-name header-value message) => (#rest results) 458 459 :parameter #key headers: An instance of ``false-or(<header-table>)``. 460 :parameter #key header-name: An instance of ``false-or(<string>)``. 461 :parameter #key header-value: An instance of ``false-or(<string>)``. 462 :parameter #key message: An instance of ``<object>``. 463 :value #rest results: An instance of ``<object>``. 464 465.. function:: bad-request-error 466 467 :signature: bad-request-error (#key headers header-name header-value reason) => (#rest results) 468 469 :parameter #key headers: An instance of ``false-or(<header-table>)``. 470 :parameter #key header-name: An instance of ``false-or(<string>)``. 471 :parameter #key header-value: An instance of ``false-or(<string>)``. 472 :parameter #key reason: An instance of ``<object>``. 473 :value #rest results: An instance of ``<object>``. 474 475.. generic-function:: chunked-transfer-encoding? 476 477 :signature: chunked-transfer-encoding? (headers) => (#rest results) 478 479 :parameter headers: An instance of ``<object>``. 480 :value #rest results: An instance of ``<object>``. 481 482.. function:: condition-class-for-status-code 483 484 :signature: condition-class-for-status-code (code) => (class) 485 486 :parameter code: An instance of ``<integer>``. 487 :value class: An instance of ``<class>``. 488 489.. function:: conflict-error 490 491 :signature: conflict-error (#key headers header-name header-value) => (#rest results) 492 493 :parameter #key headers: An instance of ``false-or(<header-table>)``. 494 :parameter #key header-name: An instance of ``false-or(<string>)``. 495 :parameter #key header-value: An instance of ``false-or(<string>)``. 496 :value #rest results: An instance of ``<object>``. 497 498.. generic-function:: content-length 499 :open: 500 501 :signature: content-length (object) => (length) 502 503 :parameter object: An instance of ``<object>``. 504 :value length: An instance of ``false-or(<integer>)``. 505 506.. function:: content-length-required-error 507 508 :signature: content-length-required-error (#key headers header-name header-value) => (#rest results) 509 510 :parameter #key headers: An instance of ``false-or(<header-table>)``. 511 :parameter #key header-name: An instance of ``false-or(<string>)``. 512 :parameter #key header-value: An instance of ``false-or(<string>)``. 513 :value #rest results: An instance of ``<object>``. 514 515.. generic-function:: cookie-comment 516 517 :signature: cookie-comment (object) => (#rest results) 518 519 :parameter object: An instance of ``<object>``. 520 :value #rest results: An instance of ``<object>``. 521 522.. generic-function:: cookie-domain 523 524 :signature: cookie-domain (object) => (#rest results) 525 526 :parameter object: An instance of ``<object>``. 527 :value #rest results: An instance of ``<object>``. 528 529.. generic-function:: cookie-max-age 530 531 :signature: cookie-max-age (object) => (#rest results) 532 533 :parameter object: An instance of ``<object>``. 534 :value #rest results: An instance of ``<object>``. 535 536.. generic-function:: cookie-name 537 538 :signature: cookie-name (object) => (#rest results) 539 540 :parameter object: An instance of ``<object>``. 541 :value #rest results: An instance of ``<object>``. 542 543.. generic-function:: cookie-path 544 545 :signature: cookie-path (object) => (#rest results) 546 547 :parameter object: An instance of ``<object>``. 548 :value #rest results: An instance of ``<object>``. 549 550.. generic-function:: cookie-value 551 552 :signature: cookie-value (object) => (#rest results) 553 554 :parameter object: An instance of ``<object>``. 555 :value #rest results: An instance of ``<object>``. 556 557.. generic-function:: cookie-version 558 559 :signature: cookie-version (object) => (#rest results) 560 561 :parameter object: An instance of ``<object>``. 562 :value #rest results: An instance of ``<object>``. 563 564.. generic-function:: date-modified 565 :open: 566 567 :signature: date-modified (object) => (date) 568 569 :parameter object: An instance of ``<object>``. 570 :value date: An instance of ``false-or(<date>)``. 571 572.. generic-function:: date-modified-setter 573 :open: 574 575 :signature: date-modified-setter (new-date object) => (new-date) 576 577 :parameter new-date: An instance of ``false-or(<date>)``. 578 :parameter object: An instance of ``<object>``. 579 :value new-date: An instance of ``false-or(<date>)``. 580 581.. function:: expectation-failed-error 582 583 :signature: expectation-failed-error (#key headers header-name header-value) => (#rest results) 584 585 :parameter #key headers: An instance of ``false-or(<header-table>)``. 586 :parameter #key header-name: An instance of ``false-or(<string>)``. 587 :parameter #key header-value: An instance of ``false-or(<string>)``. 588 :value #rest results: An instance of ``<object>``. 589 590.. generic-function:: expired? 591 592 :signature: expired? (thing) => (#rest results) 593 594 :parameter thing: An instance of ``<object>``. 595 :value #rest results: An instance of ``<object>``. 596 597.. function:: forbidden-error 598 599 :signature: forbidden-error (#key headers header-name header-value) => (#rest results) 600 601 :parameter #key headers: An instance of ``false-or(<header-table>)``. 602 :parameter #key header-name: An instance of ``false-or(<string>)``. 603 :parameter #key header-value: An instance of ``false-or(<string>)``. 604 :value #rest results: An instance of ``<object>``. 605 606.. function:: found-redirect 607 608 :signature: found-redirect (#key headers header-name header-value location) => (#rest results) 609 610 :parameter #key headers: An instance of ``false-or(<header-table>)``. 611 :parameter #key header-name: An instance of ``false-or(<string>)``. 612 :parameter #key header-value: An instance of ``false-or(<string>)``. 613 :parameter #key location: An instance of ``<object>``. 614 :value #rest results: An instance of ``<object>``. 615 616.. function:: gateway-timeout-error 617 618 :signature: gateway-timeout-error (#key headers header-name header-value) => (#rest results) 619 620 :parameter #key headers: An instance of ``false-or(<header-table>)``. 621 :parameter #key header-name: An instance of ``false-or(<string>)``. 622 :parameter #key header-value: An instance of ``false-or(<string>)``. 623 :value #rest results: An instance of ``<object>``. 624 625.. generic-function:: get-attribute 626 627 :signature: get-attribute (this key) => (value) 628 629 :parameter this: An instance of ``<attributes-mixin>``. 630 :parameter key: An instance of ``<string>``. 631 :value value: An instance of ``<object>``. 632 633.. generic-function:: get-header 634 :open: 635 636 :signature: get-header (object header-name #key parsed) => (header-value) 637 638 :parameter object: An instance of ``<object>``. 639 :parameter header-name: An instance of ``<byte-string>``. 640 :parameter #key parsed: An instance of ``<boolean>``. 641 :value header-value: An instance of ``<object>``. 642 643.. function:: gone-error 644 645 :signature: gone-error (#key headers header-name header-value) => (#rest results) 646 647 :parameter #key headers: An instance of ``false-or(<header-table>)``. 648 :parameter #key header-name: An instance of ``false-or(<string>)``. 649 :parameter #key header-value: An instance of ``false-or(<string>)``. 650 :value #rest results: An instance of ``<object>``. 651 652.. function:: grow-header-buffer 653 654 :signature: grow-header-buffer (old len) => (#rest results) 655 656 :parameter old: An instance of ``<byte-string>``. 657 :parameter len: An instance of ``<integer>``. 658 :value #rest results: An instance of ``<object>``. 659 660.. generic-function:: has-attribute? 661 662 :signature: has-attribute? (this key) => (has-it?) 663 664 :parameter this: An instance of ``<attributes-mixin>``. 665 :parameter key: An instance of ``<string>``. 666 :value has-it?: An instance of ``<boolean>``. 667 668.. function:: header-too-large-error 669 670 :signature: header-too-large-error (#key headers header-name header-value max-size) => (#rest results) 671 672 :parameter #key headers: An instance of ``false-or(<header-table>)``. 673 :parameter #key header-name: An instance of ``false-or(<string>)``. 674 :parameter #key header-value: An instance of ``false-or(<string>)``. 675 :parameter #key max-size: An instance of ``<object>``. 676 :value #rest results: An instance of ``<object>``. 677 678.. generic-function:: http-error-headers 679 680 :signature: http-error-headers (error) => (headers) 681 682 :parameter error: An instance of ``<error>``. 683 :value headers: An instance of ``false-or(<header-table>)``. 684 685.. generic-function:: http-error-message-no-code 686 687 :signature: http-error-message-no-code (error) => (#rest results) 688 689 :parameter error: An instance of ``<object>``. 690 :value #rest results: An instance of ``<object>``. 691 692.. generic-function:: http-status-code 693 694 :signature: http-status-code (error) => (code) 695 696 :parameter error: An instance of ``<error>``. 697 :value code: An instance of ``<integer>``. 698 699.. function:: http-version-not-supported-error 700 701 :signature: http-version-not-supported-error (#key headers header-name header-value version) => (#rest results) 702 703 :parameter #key headers: An instance of ``false-or(<header-table>)``. 704 :parameter #key header-name: An instance of ``false-or(<string>)``. 705 :parameter #key header-value: An instance of ``false-or(<string>)``. 706 :parameter #key version: An instance of ``<object>``. 707 :value #rest results: An instance of ``<object>``. 708 709.. function:: internal-server-error 710 711 :signature: internal-server-error (#key headers header-name header-value) => (#rest results) 712 713 :parameter #key headers: An instance of ``false-or(<header-table>)``. 714 :parameter #key header-name: An instance of ``false-or(<string>)``. 715 :parameter #key header-value: An instance of ``false-or(<string>)``. 716 :value #rest results: An instance of ``<object>``. 717 718.. generic-function:: match-media-types 719 720 :signature: match-media-types (type1 type2) => (#rest results) 721 722 :parameter type1: An instance of ``<object>``. 723 :parameter type2: An instance of ``<object>``. 724 :value #rest results: An instance of ``<object>``. 725 726.. generic-function:: media-type-exact? 727 728 :signature: media-type-exact? (mr) => (#rest results) 729 730 :parameter mr: An instance of ``<object>``. 731 :value #rest results: An instance of ``<object>``. 732 733.. generic-function:: media-type-level 734 735 :signature: media-type-level (media-type) => (#rest results) 736 737 :parameter media-type: An instance of ``<object>``. 738 :value #rest results: An instance of ``<object>``. 739 740.. generic-function:: media-type-more-specific? 741 742 :signature: media-type-more-specific? (type1 type2) => (#rest results) 743 744 :parameter type1: An instance of ``<object>``. 745 :parameter type2: An instance of ``<object>``. 746 :value #rest results: An instance of ``<object>``. 747 748.. generic-function:: media-type-quality 749 750 :signature: media-type-quality (media-type) => (#rest results) 751 752 :parameter media-type: An instance of ``<object>``. 753 :value #rest results: An instance of ``<object>``. 754 755.. function:: method-not-allowed-error 756 757 :signature: method-not-allowed-error (#key headers header-name header-value request-method) => (#rest results) 758 759 :parameter #key headers: An instance of ``false-or(<header-table>)``. 760 :parameter #key header-name: An instance of ``false-or(<string>)``. 761 :parameter #key header-value: An instance of ``false-or(<string>)``. 762 :parameter #key request-method: An instance of ``<object>``. 763 :value #rest results: An instance of ``<object>``. 764 765.. function:: moved-permanently-redirect 766 767 :signature: moved-permanently-redirect (#key headers header-name header-value location) => (#rest results) 768 769 :parameter #key headers: An instance of ``false-or(<header-table>)``. 770 :parameter #key header-name: An instance of ``false-or(<string>)``. 771 :parameter #key header-value: An instance of ``false-or(<string>)``. 772 :parameter #key location: An instance of ``<object>``. 773 :value #rest results: An instance of ``<object>``. 774 775.. function:: moved-temporarily-redirect 776 777 :signature: moved-temporarily-redirect (#key headers header-name header-value location) => (#rest results) 778 779 :parameter #key headers: An instance of ``false-or(<header-table>)``. 780 :parameter #key header-name: An instance of ``false-or(<string>)``. 781 :parameter #key header-value: An instance of ``false-or(<string>)``. 782 :parameter #key location: An instance of ``<object>``. 783 :value #rest results: An instance of ``<object>``. 784 785.. function:: not-acceptable-error 786 787 :signature: not-acceptable-error (#key headers header-name header-value) => (#rest results) 788 789 :parameter #key headers: An instance of ``false-or(<header-table>)``. 790 :parameter #key header-name: An instance of ``false-or(<string>)``. 791 :parameter #key header-value: An instance of ``false-or(<string>)``. 792 :value #rest results: An instance of ``<object>``. 793 794.. function:: not-implemented-error 795 796 :signature: not-implemented-error (#key headers header-name header-value what) => (#rest results) 797 798 :parameter #key headers: An instance of ``false-or(<header-table>)``. 799 :parameter #key header-name: An instance of ``false-or(<string>)``. 800 :parameter #key header-value: An instance of ``false-or(<string>)``. 801 :parameter #key what: An instance of ``<object>``. 802 :value #rest results: An instance of ``<object>``. 803 804.. function:: not-modified-redirect 805 806 :signature: not-modified-redirect (#key headers header-name header-value) => (#rest results) 807 808 :parameter #key headers: An instance of ``false-or(<header-table>)``. 809 :parameter #key header-name: An instance of ``false-or(<string>)``. 810 :parameter #key header-value: An instance of ``false-or(<string>)``. 811 :value #rest results: An instance of ``<object>``. 812 813.. generic-function:: note-bytes-received 814 :open: 815 816 :signature: note-bytes-received (stream byte-count) => (#rest results) 817 818 :parameter stream: An instance of ``<chunking-input-stream>``. 819 :parameter byte-count: An instance of ``<integer>``. 820 :value #rest results: An instance of ``<object>``. 821 822.. generic-function:: parse-header-value 823 :open: 824 825 :signature: parse-header-value (field-name field-values) => (parsed-field-value) 826 827 :parameter field-name: An instance of ``<symbol>``. 828 :parameter field-values: An instance of ``<field-type>:http-common-internals``. 829 :value parsed-field-value: An instance of ``<object>``. 830 831.. function:: parse-http-date 832 833 :signature: parse-http-date (str bpos epos) => (date) 834 835 :parameter str: An instance of ``<byte-string>``. 836 :parameter bpos: An instance of ``<integer>``. 837 :parameter epos: An instance of ``<integer>``. 838 :value date: An instance of ``false-or(<date>)``. 839 840.. generic-function:: parsed-headers 841 842 :signature: parsed-headers (object) => (#rest results) 843 844 :parameter object: An instance of ``<object>``. 845 :value #rest results: An instance of ``<object>``. 846 847.. function:: payment-required-error 848 849 :signature: payment-required-error (#key headers header-name header-value) => (#rest results) 850 851 :parameter #key headers: An instance of ``false-or(<header-table>)``. 852 :parameter #key header-name: An instance of ``false-or(<string>)``. 853 :parameter #key header-value: An instance of ``false-or(<string>)``. 854 :value #rest results: An instance of ``<object>``. 855 856.. function:: precondition-failed-error 857 858 :signature: precondition-failed-error (#key headers header-name header-value) => (#rest results) 859 860 :parameter #key headers: An instance of ``false-or(<header-table>)``. 861 :parameter #key header-name: An instance of ``false-or(<string>)``. 862 :parameter #key header-value: An instance of ``false-or(<string>)``. 863 :value #rest results: An instance of ``<object>``. 864 865.. function:: proxy-authentication-required-error 866 867 :signature: proxy-authentication-required-error (#key headers header-name header-value) => (#rest results) 868 869 :parameter #key headers: An instance of ``false-or(<header-table>)``. 870 :parameter #key header-name: An instance of ``false-or(<string>)``. 871 :parameter #key header-value: An instance of ``false-or(<string>)``. 872 :value #rest results: An instance of ``<object>``. 873 874.. function:: quote-html 875 876 :signature: quote-html (text #key stream) => (#rest results) 877 878 :parameter text: An instance of ``<string>``. 879 :parameter #key stream: An instance of ``<object>``. 880 :value #rest results: An instance of ``<object>``. 881 882.. generic-function:: raw-headers 883 884 :signature: raw-headers (object) => (#rest results) 885 886 :parameter object: An instance of ``<object>``. 887 :value #rest results: An instance of ``<object>``. 888 889.. function:: read-header-line 890 891 :signature: read-header-line (stream buffer bpos peek-ch require-crlf?) => (buffer bpos epos peek-ch) 892 893 :parameter stream: An instance of ``<stream>:common-extensions:common-dylan``. 894 :parameter buffer: An instance of ``<byte-string>``. 895 :parameter bpos: An instance of ``<integer>``. 896 :parameter peek-ch: An instance of ``false-or(<byte-character>)``. 897 :parameter require-crlf?: An instance of ``<boolean>``. 898 :value buffer: An instance of ``<byte-string>``. 899 :value bpos: An instance of ``<integer>``. 900 :value epos: An instance of ``<integer>``. 901 :value peek-ch: An instance of ``false-or(<byte-character>)``. 902 903.. generic-function:: read-http-line 904 905 :signature: read-http-line (stream) => (#rest results) 906 907 :parameter stream: An instance of ``<object>``. 908 :value #rest results: An instance of ``<object>``. 909 910.. function:: read-message-headers 911 912 :signature: read-message-headers (stream #key buffer start headers require-crlf?) => (headers buffer epos) 913 914 :parameter stream: An instance of ``<stream>:common-extensions:common-dylan``. 915 :parameter #key buffer: An instance of ``<byte-string>``. 916 :parameter #key start: An instance of ``<integer>``. 917 :parameter #key headers: An instance of ``<header-table>``. 918 :parameter #key require-crlf?: An instance of ``<boolean>``. 919 :value headers: An instance of ``<header-table>``. 920 :value buffer: An instance of ``<byte-string>``. 921 :value epos: An instance of ``<integer>``. 922 923.. generic-function:: remove-attribute 924 925 :signature: remove-attribute (this key) => (#rest results) 926 927 :parameter this: An instance of ``<attributes-mixin>``. 928 :parameter key: An instance of ``<string>``. 929 :value #rest results: An instance of ``<object>``. 930 931.. generic-function:: request-content 932 933 :signature: request-content (object) => (#rest results) 934 935 :parameter object: An instance of ``<object>``. 936 :value #rest results: An instance of ``<object>``. 937 938.. generic-function:: request-content-setter 939 940 :signature: request-content-setter (value object) => (#rest results) 941 942 :parameter value: An instance of ``<object>``. 943 :parameter object: An instance of ``<object>``. 944 :value #rest results: An instance of ``<object>``. 945 946.. function:: request-entity-too-large-error 947 948 :signature: request-entity-too-large-error (#key headers header-name header-value max-size) => (#rest results) 949 950 :parameter #key headers: An instance of ``false-or(<header-table>)``. 951 :parameter #key header-name: An instance of ``false-or(<string>)``. 952 :parameter #key header-value: An instance of ``false-or(<string>)``. 953 :parameter #key max-size: An instance of ``<object>``. 954 :value #rest results: An instance of ``<object>``. 955 956.. generic-function:: request-method 957 958 :signature: request-method (object) => (#rest results) 959 960 :parameter object: An instance of ``<object>``. 961 :value #rest results: An instance of ``<object>``. 962 963.. generic-function:: request-method-setter 964 965 :signature: request-method-setter (value object) => (#rest results) 966 967 :parameter value: An instance of ``<object>``. 968 :parameter object: An instance of ``<object>``. 969 :value #rest results: An instance of ``<object>``. 970 971.. generic-function:: request-raw-url-string 972 973 :signature: request-raw-url-string (object) => (#rest results) 974 975 :parameter object: An instance of ``<object>``. 976 :value #rest results: An instance of ``<object>``. 977 978.. generic-function:: request-raw-url-string-setter 979 980 :signature: request-raw-url-string-setter (value object) => (#rest results) 981 982 :parameter value: An instance of ``<object>``. 983 :parameter object: An instance of ``<object>``. 984 :value #rest results: An instance of ``<object>``. 985 986.. function:: request-timeout-error 987 988 :signature: request-timeout-error (#key headers header-name header-value seconds) => (#rest results) 989 990 :parameter #key headers: An instance of ``false-or(<header-table>)``. 991 :parameter #key header-name: An instance of ``false-or(<string>)``. 992 :parameter #key header-value: An instance of ``false-or(<string>)``. 993 :parameter #key seconds: An instance of ``<object>``. 994 :value #rest results: An instance of ``<object>``. 995 996.. function:: request-uri-too-long-error 997 998 :signature: request-uri-too-long-error (#key headers header-name header-value max-size) => (#rest results) 999 1000 :parameter #key headers: An instance of ``false-or(<header-table>)``. 1001 :parameter #key header-name: An instance of ``false-or(<string>)``. 1002 :parameter #key header-value: An instance of ``false-or(<string>)``. 1003 :parameter #key max-size: An instance of ``<object>``. 1004 :value #rest results: An instance of ``<object>``. 1005 1006.. generic-function:: request-url 1007 1008 :signature: request-url (object) => (#rest results) 1009 1010 :parameter object: An instance of ``<object>``. 1011 :value #rest results: An instance of ``<object>``. 1012 1013.. generic-function:: request-url-setter 1014 1015 :signature: request-url-setter (value object) => (#rest results) 1016 1017 :parameter value: An instance of ``<object>``. 1018 :parameter object: An instance of ``<object>``. 1019 :value #rest results: An instance of ``<object>``. 1020 1021.. generic-function:: request-version 1022 1023 :signature: request-version (object) => (#rest results) 1024 1025 :parameter object: An instance of ``<object>``. 1026 :value #rest results: An instance of ``<object>``. 1027 1028.. generic-function:: request-version-setter 1029 1030 :signature: request-version-setter (value object) => (#rest results) 1031 1032 :parameter value: An instance of ``<object>``. 1033 :parameter object: An instance of ``<object>``. 1034 :value #rest results: An instance of ``<object>``. 1035 1036.. function:: requested-range-not-satisfiable-error 1037 1038 :signature: requested-range-not-satisfiable-error (#key headers header-name header-value) => (#rest results) 1039 1040 :parameter #key headers: An instance of ``false-or(<header-table>)``. 1041 :parameter #key header-name: An instance of ``false-or(<string>)``. 1042 :parameter #key header-value: An instance of ``false-or(<string>)``. 1043 :value #rest results: An instance of ``<object>``. 1044 1045.. function:: resource-not-found-error 1046 1047 :signature: resource-not-found-error (#key headers header-name header-value url) => (#rest results) 1048 1049 :parameter #key headers: An instance of ``false-or(<header-table>)``. 1050 :parameter #key header-name: An instance of ``false-or(<string>)``. 1051 :parameter #key header-value: An instance of ``false-or(<string>)``. 1052 :parameter #key url: An instance of ``<object>``. 1053 :value #rest results: An instance of ``<object>``. 1054 1055.. generic-function:: response-chunked? 1056 1057 :signature: response-chunked? (object) => (#rest results) 1058 1059 :parameter object: An instance of ``<object>``. 1060 :value #rest results: An instance of ``<object>``. 1061 1062.. generic-function:: response-chunked?-setter 1063 1064 :signature: response-chunked?-setter (value object) => (#rest results) 1065 1066 :parameter value: An instance of ``<object>``. 1067 :parameter object: An instance of ``<object>``. 1068 :value #rest results: An instance of ``<object>``. 1069 1070.. generic-function:: response-code 1071 1072 :signature: response-code (object) => (#rest results) 1073 1074 :parameter object: An instance of ``<object>``. 1075 :value #rest results: An instance of ``<object>``. 1076 1077.. generic-function:: response-code-setter 1078 1079 :signature: response-code-setter (value object) => (#rest results) 1080 1081 :parameter value: An instance of ``<object>``. 1082 :parameter object: An instance of ``<object>``. 1083 :value #rest results: An instance of ``<object>``. 1084 1085.. generic-function:: response-reason-phrase 1086 1087 :signature: response-reason-phrase (object) => (#rest results) 1088 1089 :parameter object: An instance of ``<object>``. 1090 :value #rest results: An instance of ``<object>``. 1091 1092.. generic-function:: response-reason-phrase-setter 1093 1094 :signature: response-reason-phrase-setter (value object) => (#rest results) 1095 1096 :parameter value: An instance of ``<object>``. 1097 :parameter object: An instance of ``<object>``. 1098 :value #rest results: An instance of ``<object>``. 1099 1100.. generic-function:: response-request 1101 1102 :signature: response-request (object) => (#rest results) 1103 1104 :parameter object: An instance of ``<object>``. 1105 :value #rest results: An instance of ``<object>``. 1106 1107.. function:: see-other-redirect 1108 1109 :signature: see-other-redirect (#key headers header-name header-value location) => (#rest results) 1110 1111 :parameter #key headers: An instance of ``false-or(<header-table>)``. 1112 :parameter #key header-name: An instance of ``false-or(<string>)``. 1113 :parameter #key header-value: An instance of ``false-or(<string>)``. 1114 :parameter #key location: An instance of ``<object>``. 1115 :value #rest results: An instance of ``<object>``. 1116 1117.. function:: service-unavailable-error 1118 1119 :signature: service-unavailable-error (#key headers header-name header-value) => (#rest results) 1120 1121 :parameter #key headers: An instance of ``false-or(<header-table>)``. 1122 :parameter #key header-name: An instance of ``false-or(<string>)``. 1123 :parameter #key header-value: An instance of ``false-or(<string>)``. 1124 :value #rest results: An instance of ``<object>``. 1125 1126.. generic-function:: set-attribute 1127 1128 :signature: set-attribute (this key value) => (#rest results) 1129 1130 :parameter this: An instance of ``<attributes-mixin>``. 1131 :parameter key: An instance of ``<string>``. 1132 :parameter value: An instance of ``<object>``. 1133 :value #rest results: An instance of ``<object>``. 1134 1135.. generic-function:: set-header 1136 :open: 1137 1138 :signature: set-header (object header value #key if-exists?) => (#rest results) 1139 1140 :parameter object: An instance of ``<object>``. 1141 :parameter header: An instance of ``<byte-string>``. 1142 :parameter value: An instance of ``<object>``. 1143 :parameter #key if-exists?: An instance of ``one-of(#"replace", #"append", #"ignore", #"error")``. 1144 :value #rest results: An instance of ``<object>``. 1145 1146.. function:: token-end-position 1147 1148 :signature: token-end-position (buf bpos epos) => (#rest results) 1149 1150 :parameter buf: An instance of ``<byte-string>``. 1151 :parameter bpos: An instance of ``<integer>``. 1152 :parameter epos: An instance of ``<integer>``. 1153 :value #rest results: An instance of ``<object>``. 1154 1155.. function:: unauthorized-error 1156 1157 :signature: unauthorized-error (#key headers header-name header-value) => (#rest results) 1158 1159 :parameter #key headers: An instance of ``false-or(<header-table>)``. 1160 :parameter #key header-name: An instance of ``false-or(<string>)``. 1161 :parameter #key header-value: An instance of ``false-or(<string>)``. 1162 :value #rest results: An instance of ``<object>``. 1163 1164.. function:: unsupported-media-type-error 1165 1166 :signature: unsupported-media-type-error (#key headers header-name header-value) => (#rest results) 1167 1168 :parameter #key headers: An instance of ``false-or(<header-table>)``. 1169 :parameter #key header-name: An instance of ``false-or(<string>)``. 1170 :parameter #key header-value: An instance of ``false-or(<string>)``. 1171 :value #rest results: An instance of ``<object>``. 1172 1173.. function:: use-proxy-redirect 1174 1175 :signature: use-proxy-redirect (#key headers header-name header-value location) => (#rest results) 1176 1177 :parameter #key headers: An instance of ``false-or(<header-table>)``. 1178 :parameter #key header-name: An instance of ``false-or(<string>)``. 1179 :parameter #key header-value: An instance of ``false-or(<string>)``. 1180 :parameter #key location: An instance of ``<object>``. 1181 :value #rest results: An instance of ``<object>``. 1182 1183.. generic-function:: validate-http-status-code 1184 1185 :signature: validate-http-status-code (status-code) => (#rest results) 1186 1187 :parameter status-code: An instance of ``<object>``. 1188 :value #rest results: An instance of ``<object>``. 1189 1190.. generic-function:: validate-http-version 1191 1192 :signature: validate-http-version (version) => (#rest results) 1193 1194 :parameter version: An instance of ``<object>``. 1195 :value #rest results: An instance of ``<object>``. 1196