The C<X::Protocol::HTTP> contains adjustments to X::Protocol for HTTP.
This includes standard human-readable strings, and some additional
"severity" levels that may be useful for flow control decisions.


Additional tweaks can be added easily by subclassing.  Suggestions
for better defaults are always welcome.


Codes between 400 and 499 are of severity "error" and C<.toss> will
throw them.  Codes 500 and above are of severity "failure" and
C<.toss> will result in a C<Failure>.


use X::Protocol;
# Since we may end up used by some important stuff, be backward compatible
# for a while
#unit class X::Protocol::HTTP is X::Protocol;
class X::Protocol::HTTP is X::Protocol {



X::Protocol::HTTP - Perl6 Exception class for HTTP results


NAME

code

=begin code

    use X::Protocol::HTTP;

    $result = get_some_object_from_an_HTTP_library();

    # Assuming $result stringifies usefully, just hook it with :origin
    X::Protocol::HTTP.new(:code($result.status) :origin($result)).toss;

=end code


SYNOPSIS

DESCRIPTION


has $.origin; # Place to hook URLs or such.  Will be stringified.

method protocol { 'HTTP' }

method codes {
    {
        100 => 'Continue',
        101 => 'Switching Protocols',
        102 => 'Processing',                      # RFC 2518 (WebDAV)
        200 => 'OK',
        201 => 'Created',
        202 => 'Accepted',
        203 => 'Non-Authoritative Information',
        204 => 'No Content',
        205 => 'Reset Content',
        206 => 'Partial Content',
        207 => 'Multi-Status',                    # RFC 2518 (WebDAV)
        208 => 'Already Reported',                # RFC 5842
        300 => 'Multiple Choices',
        301 => 'Moved Permanently',
        302 => 'Found',
        303 => 'See Other',
        304 => 'Not Modified',
        305 => 'Use Proxy',
        307 => 'Temporary Redirect',
        400 => 'Bad Request',
        401 => 'Unauthorized',
        402 => 'Payment Required',
        403 => 'Forbidden',
        404 => 'Not Found',
        405 => 'Method Not Allowed',
        406 => 'Not Acceptable',
        407 => 'Proxy Authentication Required',
        408 => 'Request Timeout',
        409 => 'Conflict',
        410 => 'Gone',
        411 => 'Length Required',
        412 => 'Precondition Failed',
        413 => 'Request Entity Too Large',
        414 => 'Request-URI Too Large',
        415 => 'Unsupported Media Type',
        416 => 'Request Range Not Satisfiable',
        417 => 'Expectation Failed',
        418 => 'I\'m a teapot',                   # RFC 2324
        422 => 'Unprocessable Entity',            # RFC 2518 (WebDAV)
        423 => 'Locked',                          # RFC 2518 (WebDAV)
        424 => 'Failed Dependency',               # RFC 2518 (WebDAV)
        425 => 'No code',                         # WebDAV Advanced Collections
        426 => 'Upgrade Required',                # RFC 2817
        428 => 'Precondition Required',
        429 => 'Too Many Requests',
        431 => 'Request Header Fields Too Large',
        449 => 'Retry with',                      # unofficial Microsoft
        451 => 'Unavailable For Legal Reasons',   # IESG Dec 18, 2015 RFC TBA
        500 => 'Internal Server Error',
        501 => 'Not Implemented',
        502 => 'Bad Gateway',
        503 => 'Service Unavailable',
        504 => 'Gateway Timeout',
        505 => 'HTTP Version Not Supported',
        506 => 'Variant Also Negotiates',         # RFC 2295
        507 => 'Insufficient Storage',            # RFC 2518 (WebDAV)
        509 => 'Bandwidth Limit Exceeded',        # unofficial
        510 => 'Not Extended',                    # RFC 2774
        511 => 'Network Authentication Required',
    }
}

method severity {
    given $.status {
        # Hopefully these will be useful.  Suggestions welcome.
        when 102 { "delay" }
        when 208|304 { "unchanged" }
        when 207 { "followup" }
        when { +$_ < 300 } { "success" }
        when { +$_ < 400 } { "followup" }
        when { +$_ < 500 } { "error" }
	default { "failure" }
    }
}

method gist {
    given $.origin {
        return callsame unless $_;
        callsame ~ "\n(From $_)";
    }
}



AUTHOR

Codes and human-readable text were taken from HTTP::Message,
    Copyright (c) 1995-2008 Gisle Aas.


COPYRIGHT

This program is free software; you can redistribute it and/or modify
it under the terms of the Perl Artistic License 2.0.


LICENSE

SEE-ALSO


# temporary backwards compatibility instead of "unit"
}

root

The C<X::Protocol::X11> contains adjustments to X::Protocol for the
X11 protocol.  This includes standard human-readable strings, and
use of additional fields in X11 protocol structures.


X::Protocol::X11 - Perl6 Exception class for X11 Protocol Errors


The C<X::Protocol> superclass is a convenience for working with status results
in protocol code.  It allows one to reap the benefits of typed exceptions
without having to type out their names very often.  You simply feed the
error code from the protocol in as an argument to X::Protocol.new (or,
more usually, to a subclass) and it is automatically paired with a human
readable error message, producing an object that can be printed, thrown,
or inspected.


One can easily tell a protocol error apart from an internal code error
by whether it matches C<X::Protocol>, and tell which protocol an error came
from either by looking at the C<.protocol> attribute, or checking which
subclass it belongs to.


Better yet, you can simply smart match the object against integers, strings
and regular expressions in your error handling code.


For commonly used protocols, the X::Protocol module repo serves as a place
for protocol-specific subclasses to store long lists of human-readable
error messages so they can be shared by different protocol implementations
and maintained in one place.


X::Protocol - Perl6 Exception superclass for protocol result codes


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React
